Class: Embulk::Input::Mixpanel

Inherits:
InputPlugin
  • Object
show all
Defined in:
lib/embulk/input/mixpanel.rb

Constant Summary collapse

GUESS_RECORDS_COUNT = 
10
SLICE_DAYS_COUNT =

NOTE: It takes long time to fetch data between from_date to to_date by one API request. So this plugin fetches data between each 7 (SLICE_DAYS_COUNT) days.

7

Class Method Summary collapse

Instance Method Summary collapse

Class Method Details

.guess(config) ⇒ Object 



92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
 
# File 'lib/embulk/input/mixpanel.rb', line 92

def self.guess(config)
  client = MixpanelApi::Client.new(config.param(:api_key, :string), config.param(:api_secret, :string))

  from_date_str = config.param(:from_date, :string, default: (Date.today - 1 - SLICE_DAYS_COUNT).to_s)

  from_date = Date.parse(from_date_str)

  if from_date > Date.today - 1
    raise ConfigError, "Please specify date later than yesterday (inclusive) as 'from_date'"
  end

  # NOTE: to_date is yeasterday if from_date..Date.Today doesn't have
  # more SLICE_DAYS_COUNT days.
  to_date = [from_date + SLICE_DAYS_COUNT, Date.today - 1].min

  params = export_params(config)
  params = params.merge(
    from_date: from_date.to_s,
    to_date: to_date.to_s,
  )

  records = client.export(params)
  sample_records = records.first(GUESS_RECORDS_COUNT)
  properties = Guess::SchemaGuess.from_hash_records(sample_records.map{|r| r["properties"]})
  columns = properties.map do |col|
    result = {
      name: col.name,
      type: col.type,
    }
    result[:format] = col.format if col.format
    result
  end
  columns.unshift(name: "event", type: :string)
  return {"columns" => columns}
end

.resume(task, columns, count, &control) ⇒ Object 



80
81
82
83
84
85
86
87
88
89
90
 
# File 'lib/embulk/input/mixpanel.rb', line 80

def self.resume(task, columns, count, &control)
  commit_reports = yield(task, columns, count)

  # NOTE: If this plugin supports to run by multi threads, this
  # implementation is terrible.
  commit_report = commit_reports.first
  next_to_date = Date.parse(commit_report[:to_date]).next

  next_config_diff = {from_date: next_to_date.to_s}
  return next_config_diff
end

.transaction(config, &control) ⇒ Object 



16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
 
# File 'lib/embulk/input/mixpanel.rb', line 16

def self.transaction(config, &control)
  task = {}

  task[:params] = export_params(config)

  begin
    from_date_str = config.param(:from_date, :string, default: (Date.today - 2).to_s)
    from_date = Date.parse(from_date_str)
  rescue ArgumentError # invalid date
    raise ConfigError, "from_date '#{from_date_str}' is invalid date"
  end

  if from_date > Date.today - 1
    Embulk.logger.warn "Mixpanel allow 2 days before to from_date, so no data is input."
    target_dates = []
  else
    days = config.param(:fetch_days, :integer, default: nil)

    if days.nil?
      # When no 'days' is specified in config file, so dates is
      # generated by from_date and yeasterday.
      dates = from_date..(Date.today - 1)
    elsif days < 1
      raise ConfigError, "days '#{days}' is invalid. Please specify bigger number than 0."
    else
      # When 'days' is specified in config file and it is satisfied,
      # so it is used for dates.
      dates = from_date..(from_date + days - 1)
    end

    target_dates = dates.find_all {|date| date < Date.today}

    overtimes = dates.to_a - target_dates
    unless overtimes.empty?
      Embulk.logger.warn "These dates are too early access, ignored them: #{overtimes.map(&:to_s).join(', ')}"
    end
  end

  task[:dates] = target_dates.map {|date| date.to_s}

  task[:api_key] = config.param(:api_key, :string)
  task[:api_secret] = config.param(:api_secret, :string)
  task[:timezone] = config.param(:timezone, :string)

  begin
    # raises exception if timezone is invalid string
    TZInfo::Timezone.get(task[:timezone])
  rescue => e
    Embulk.logger.error "'#{task[:timezone]}' is invalid timezone"
    raise ConfigError, e.message
  end

  columns = []
  task[:schema] = config.param(:columns, :array)
  task[:schema].each do |column|
    name = column["name"]
    type = column["type"].to_sym

    columns << Column.new(nil, name, type, column["format"])
  end

  resume(task, columns, 1, &control)
end

Instance Method Details

#init ⇒ Object 



128
129
130
131
132
133
134
135
 
# File 'lib/embulk/input/mixpanel.rb', line 128

def init
  @api_key = task[:api_key]
  @api_secret = task[:api_secret]
  @params = task[:params]
  @timezone = task[:timezone]
  @schema = task[:schema]
  @dates = task[:dates]
end

#run ⇒ Object 



137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
 
# File 'lib/embulk/input/mixpanel.rb', line 137

def run
  client = MixpanelApi::Client.new(@api_key, @api_secret)
  @dates.each_slice(SLICE_DAYS_COUNT) do |dates|
    from_date = dates.first
    to_date = dates.last
    Embulk.logger.info "Fetching data from #{from_date} to #{to_date} ..."

    params = @params.merge(
      "from_date" => from_date,
      "to_date" => to_date
    )

    records = client.export(params)

    records.each do |record|
      values = @schema.map do |column|
        case column["name"]
        when "event"
          record["event"]
        when "time"
          time = record["properties"]["time"]
          adjust_timezone(time)
        else
          record["properties"][column["name"]]
        end
      end
      page_builder.add(values)
    end

    break if preview?
  end

  page_builder.finish

  commit_report = {to_date: @dates.last || (Date.today - 1)}
  return commit_report
end