mix_reader 0.1.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
checksums.yaml ADDED
@@ -0,0 +1,7 @@
1
+ ---
2
+ SHA1:
3
+ metadata.gz: 160c6721e931f9a107a50b0a95c320392475402a
4
+ data.tar.gz: 993e96e4f2ef4e83a0fb813c068463412567846b
5
+ SHA512:
6
+ metadata.gz: 8ed239531c6b2723d3169708a75739d02e6a49fde1de13c7cafefe26b194c303cd29bfe45b5ebf66d72dedf72363c29d8890781112c37bfcae9f18e322cca6ab
7
+ data.tar.gz: 593789f6ea46fcf4f668f0e1f9ea90fcfe9574e8059a424c38df2a49dfa092e9ca7d701d041792d5cffed4001689df888bae701c7754fed587a247b6889afc77
data/.DS_Store ADDED
Binary file
data/.gitignore ADDED
@@ -0,0 +1,9 @@
1
+ /.bundle/
2
+ /.yardoc
3
+ /Gemfile.lock
4
+ /_yardoc/
5
+ /coverage/
6
+ /doc/
7
+ /pkg/
8
+ /spec/reports/
9
+ /tmp/
data/.travis.yml ADDED
@@ -0,0 +1,5 @@
1
+ sudo: false
2
+ language: ruby
3
+ rvm:
4
+ - 2.1.8
5
+ before_install: gem install bundler -v 1.13.6
data/Gemfile ADDED
@@ -0,0 +1,4 @@
1
+ source 'https://rubygems.org'
2
+
3
+ # Specify your gem's dependencies in mix_reader.gemspec
4
+ gemspec
data/LICENSE.txt ADDED
@@ -0,0 +1,21 @@
1
+ The MIT License (MIT)
2
+
3
+ Copyright (c) 2016 TODO: Write your name
4
+
5
+ Permission is hereby granted, free of charge, to any person obtaining a copy
6
+ of this software and associated documentation files (the "Software"), to deal
7
+ in the Software without restriction, including without limitation the rights
8
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
+ copies of the Software, and to permit persons to whom the Software is
10
+ furnished to do so, subject to the following conditions:
11
+
12
+ The above copyright notice and this permission notice shall be included in
13
+ all copies or substantial portions of the Software.
14
+
15
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
21
+ THE SOFTWARE.
data/README.md ADDED
@@ -0,0 +1,41 @@
1
+ # MixReader
2
+
3
+ Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/mix_reader`. To experiment with that code, run `bin/console` for an interactive prompt.
4
+
5
+ TODO: Delete this and the text above, and describe your gem
6
+
7
+ ## Installation
8
+
9
+ Add this line to your application's Gemfile:
10
+
11
+ ```ruby
12
+ gem 'mix_reader'
13
+ ```
14
+
15
+ And then execute:
16
+
17
+ $ bundle
18
+
19
+ Or install it yourself as:
20
+
21
+ $ gem install mix_reader
22
+
23
+ ## Usage
24
+
25
+ TODO: Write usage instructions here
26
+
27
+ ## Development
28
+
29
+ After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
30
+
31
+ To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
32
+
33
+ ## Contributing
34
+
35
+ Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/mix_reader.
36
+
37
+
38
+ ## License
39
+
40
+ The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
41
+
data/Rakefile ADDED
@@ -0,0 +1,10 @@
1
+ require "bundler/gem_tasks"
2
+ require "rake/testtask"
3
+
4
+ Rake::TestTask.new(:test) do |t|
5
+ t.libs << "test"
6
+ t.libs << "lib"
7
+ t.test_files = FileList['test/**/*_test.rb']
8
+ end
9
+
10
+ task :default => :test
data/bin/console ADDED
@@ -0,0 +1,14 @@
1
+ #!/usr/bin/env ruby
2
+
3
+ require "bundler/setup"
4
+ require "mix_reader"
5
+
6
+ # You can add fixtures and/or initialization code here to make experimenting
7
+ # with your gem easier. You can also use a different console, if you like.
8
+
9
+ # (If you use this, don't forget to add pry to your Gemfile!)
10
+ # require "pry"
11
+ # Pry.start
12
+
13
+ require "irb"
14
+ IRB.start
data/bin/setup ADDED
@@ -0,0 +1,8 @@
1
+ #!/usr/bin/env bash
2
+ set -euo pipefail
3
+ IFS=$'\n\t'
4
+ set -vx
5
+
6
+ bundle install
7
+
8
+ # Do any other automated setup that you need to do here
data/lib/.DS_Store ADDED
Binary file
@@ -0,0 +1,5 @@
1
+ module MixReader do
2
+ class Configuration
3
+ attr_accessor :api_secret
4
+ end
5
+ end
data/lib/mix_reader.rb ADDED
@@ -0,0 +1,19 @@
1
+ require "mix_reader/version"
2
+ require "mix_reader/configuration"
3
+ require "mix_reader/base"
4
+ require "mix_reader/people"
5
+ require "mix_reader/events"
6
+
7
+ module MixReader
8
+ class << self
9
+ attr_writer :configuration
10
+ end
11
+
12
+ def self.configuration
13
+ @configuration ||= Configuration.new
14
+ end
15
+
16
+ def self.configure
17
+ yield(configuration)
18
+ end
19
+ end
@@ -0,0 +1,67 @@
1
+ require 'httparty'
2
+ module MixReader
3
+ class Base
4
+ include HTTParty
5
+
6
+ MIXPANEL_JQL_URL = "https://mixpanel.com/api/2.0/jql"
7
+
8
+ attr_accessor :filters, :script, :options
9
+
10
+ class << self
11
+ def query(args)
12
+ raise "invalid arguments" unless args.is_a?(Hash)
13
+
14
+ new(args).query
15
+ end
16
+ end
17
+
18
+ def initialize(args)
19
+ raise "can not instantiate base class" if class_name == "Base"
20
+ @filters = args
21
+ end
22
+
23
+ def query
24
+ build_script
25
+ build_options
26
+ query_and_init_objects
27
+ end
28
+
29
+ private
30
+
31
+ def query_and_init_objects
32
+ response = send_request
33
+ data = response.parsed_response
34
+ data.map do |item|
35
+ item_data = item["properties"]
36
+ h = {}
37
+ item_data.each{ |k, v| h[k[1..-1]] = v if k[0] == '$' }
38
+ item_data["class_name"] = class_name
39
+ item_data
40
+ end
41
+ end
42
+
43
+ def send_request
44
+ self.class.send("post", MIXPANEL_JQL_URL, @options)
45
+ end
46
+
47
+ def build_options
48
+ @options = {
49
+ basic_auth: { username: api_secret },
50
+ body: { script: script }
51
+ }
52
+ end
53
+
54
+ def m_key(key)
55
+ return key unless key[0] >= 'a' && key[0] <= 'z'
56
+ '$' + key
57
+ end
58
+
59
+ def class_name
60
+ self.class.name.split("::").last
61
+ end
62
+
63
+ def api_secret
64
+ MixReader::configuration.api_secret
65
+ end
66
+ end
67
+ end
@@ -0,0 +1,5 @@
1
+ module MixReader
2
+ class Configuration
3
+ attr_accessor :api_secret
4
+ end
5
+ end
@@ -0,0 +1,28 @@
1
+ module MixReader
2
+ class Events < MixReader::Base
3
+ EVENT_SELECTORS = %w(from_date to_date event_selectors)
4
+ JQL_SCRIPT_MAIN = 'PARAMS function main(){return Events(params)}'
5
+ JQL_SCRIPT_PARAMS = "params = PARAMS_HASH;"
6
+
7
+ attr_accessor :selectors
8
+
9
+ def initialize(args)
10
+ super
11
+ extract_selectors
12
+ end
13
+
14
+ def build_script
15
+ params = JQL_SCRIPT_PARAMS.sub("PARAMS_HASH", selectors)
16
+ @script = JQL_SCRIPT_MAIN.sub("PARAMS", params)
17
+ end
18
+
19
+ def extract_selectors
20
+ query_filters = {}
21
+ EVENT_SELECTORS.each do |key|
22
+ value = self.filters.delete(key.to_sym)
23
+ query_filters[key.to_sym] = value unless value.nil?
24
+ end
25
+ @selectors = query_filters.to_json
26
+ end
27
+ end
28
+ end
@@ -0,0 +1,30 @@
1
+ module MixReader
2
+ class People < MixReader::Base
3
+ JQL_SCRIPT_MAIN = 'PARAMS function main(){ SCRIPT_QUERY }'
4
+ JQL_SCRIPT_CLASS = 'return People()'
5
+ JQL_SCRIPT_FILTER = '.filter(function(entity){ return FILTER_STRING });'
6
+ JQL_SCRIPT_PARAMS = "params = PARAMS_HASH;"
7
+
8
+ def build_script
9
+ params = ""
10
+ query_string = JQL_SCRIPT_CLASS
11
+
12
+ if filters.any?
13
+ query_string += JQL_SCRIPT_FILTER.sub("FILTER_STRING", filter_string)
14
+ params = JQL_SCRIPT_PARAMS.sub("PARAMS_HASH", filters.to_json)
15
+ end
16
+ @script = JQL_SCRIPT_MAIN.sub("SCRIPT_QUERY", query_string).sub("PARAMS", params)
17
+ end
18
+
19
+ def filter_string
20
+ return "" unless filters.any?
21
+
22
+ equal_filters = filters.clone
23
+
24
+ predicates = equal_filters
25
+ .map{ |k, v| "entity.properties.#{m_key(k.to_s)} == params.#{k}" }
26
+
27
+ predicates.join("&&") + ";"
28
+ end
29
+ end
30
+ end
@@ -0,0 +1,3 @@
1
+ module MixReader
2
+ VERSION = "0.1.0"
3
+ end
@@ -0,0 +1,29 @@
1
+ # coding: utf-8
2
+ lib = File.expand_path('../lib', __FILE__)
3
+ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
4
+ require 'mix_reader/version'
5
+
6
+ Gem::Specification.new do |spec|
7
+ spec.name = "mix_reader"
8
+ spec.version = MixReader::VERSION
9
+ spec.authors = ["Murty Korada"]
10
+ spec.email = ["murtyk@yahoo.com"]
11
+
12
+ spec.summary = %q{API for running JQL on MixPanel to get events and people.}
13
+ spec.homepage = "https://github.com/murtyk/mix_reader"
14
+ spec.license = "MIT"
15
+
16
+ spec.files = `git ls-files -z`.split("\x0").reject do |f|
17
+ f.match(%r{^(test|spec|features)/})
18
+ end
19
+ spec.bindir = "exe"
20
+ spec.executables = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
21
+ spec.require_paths = ["lib"]
22
+
23
+ spec.add_development_dependency "bundler", "~> 1.13"
24
+ spec.add_development_dependency "rake", "~> 10.0"
25
+ spec.add_development_dependency "minitest", "~> 5.0"
26
+ spec.add_development_dependency "vcr", "~> 3.0"
27
+ spec.add_development_dependency "webmock", "~> 1.21"
28
+ spec.add_dependency "httparty", "~> 0.13"
29
+ end
metadata ADDED
@@ -0,0 +1,146 @@
1
+ --- !ruby/object:Gem::Specification
2
+ name: mix_reader
3
+ version: !ruby/object:Gem::Version
4
+ version: 0.1.0
5
+ platform: ruby
6
+ authors:
7
+ - Murty Korada
8
+ autorequire:
9
+ bindir: exe
10
+ cert_chain: []
11
+ date: 2016-12-11 00:00:00.000000000 Z
12
+ dependencies:
13
+ - !ruby/object:Gem::Dependency
14
+ name: bundler
15
+ requirement: !ruby/object:Gem::Requirement
16
+ requirements:
17
+ - - "~>"
18
+ - !ruby/object:Gem::Version
19
+ version: '1.13'
20
+ type: :development
21
+ prerelease: false
22
+ version_requirements: !ruby/object:Gem::Requirement
23
+ requirements:
24
+ - - "~>"
25
+ - !ruby/object:Gem::Version
26
+ version: '1.13'
27
+ - !ruby/object:Gem::Dependency
28
+ name: rake
29
+ requirement: !ruby/object:Gem::Requirement
30
+ requirements:
31
+ - - "~>"
32
+ - !ruby/object:Gem::Version
33
+ version: '10.0'
34
+ type: :development
35
+ prerelease: false
36
+ version_requirements: !ruby/object:Gem::Requirement
37
+ requirements:
38
+ - - "~>"
39
+ - !ruby/object:Gem::Version
40
+ version: '10.0'
41
+ - !ruby/object:Gem::Dependency
42
+ name: minitest
43
+ requirement: !ruby/object:Gem::Requirement
44
+ requirements:
45
+ - - "~>"
46
+ - !ruby/object:Gem::Version
47
+ version: '5.0'
48
+ type: :development
49
+ prerelease: false
50
+ version_requirements: !ruby/object:Gem::Requirement
51
+ requirements:
52
+ - - "~>"
53
+ - !ruby/object:Gem::Version
54
+ version: '5.0'
55
+ - !ruby/object:Gem::Dependency
56
+ name: vcr
57
+ requirement: !ruby/object:Gem::Requirement
58
+ requirements:
59
+ - - "~>"
60
+ - !ruby/object:Gem::Version
61
+ version: '3.0'
62
+ type: :development
63
+ prerelease: false
64
+ version_requirements: !ruby/object:Gem::Requirement
65
+ requirements:
66
+ - - "~>"
67
+ - !ruby/object:Gem::Version
68
+ version: '3.0'
69
+ - !ruby/object:Gem::Dependency
70
+ name: webmock
71
+ requirement: !ruby/object:Gem::Requirement
72
+ requirements:
73
+ - - "~>"
74
+ - !ruby/object:Gem::Version
75
+ version: '1.21'
76
+ type: :development
77
+ prerelease: false
78
+ version_requirements: !ruby/object:Gem::Requirement
79
+ requirements:
80
+ - - "~>"
81
+ - !ruby/object:Gem::Version
82
+ version: '1.21'
83
+ - !ruby/object:Gem::Dependency
84
+ name: httparty
85
+ requirement: !ruby/object:Gem::Requirement
86
+ requirements:
87
+ - - "~>"
88
+ - !ruby/object:Gem::Version
89
+ version: '0.13'
90
+ type: :runtime
91
+ prerelease: false
92
+ version_requirements: !ruby/object:Gem::Requirement
93
+ requirements:
94
+ - - "~>"
95
+ - !ruby/object:Gem::Version
96
+ version: '0.13'
97
+ description:
98
+ email:
99
+ - murtyk@yahoo.com
100
+ executables: []
101
+ extensions: []
102
+ extra_rdoc_files: []
103
+ files:
104
+ - ".DS_Store"
105
+ - ".gitignore"
106
+ - ".travis.yml"
107
+ - Gemfile
108
+ - LICENSE.txt
109
+ - README.md
110
+ - Rakefile
111
+ - bin/console
112
+ - bin/setup
113
+ - lib/.DS_Store
114
+ - lib/configuration.rb
115
+ - lib/mix_reader.rb
116
+ - lib/mix_reader/base.rb
117
+ - lib/mix_reader/configuration.rb
118
+ - lib/mix_reader/events.rb
119
+ - lib/mix_reader/people.rb
120
+ - lib/mix_reader/version.rb
121
+ - mix_reader.gemspec
122
+ homepage: https://github.com/murtyk/mix_reader
123
+ licenses:
124
+ - MIT
125
+ metadata: {}
126
+ post_install_message:
127
+ rdoc_options: []
128
+ require_paths:
129
+ - lib
130
+ required_ruby_version: !ruby/object:Gem::Requirement
131
+ requirements:
132
+ - - ">="
133
+ - !ruby/object:Gem::Version
134
+ version: '0'
135
+ required_rubygems_version: !ruby/object:Gem::Requirement
136
+ requirements:
137
+ - - ">="
138
+ - !ruby/object:Gem::Version
139
+ version: '0'
140
+ requirements: []
141
+ rubyforge_project:
142
+ rubygems_version: 2.4.8
143
+ signing_key:
144
+ specification_version: 4
145
+ summary: API for running JQL on MixPanel to get events and people.
146
+ test_files: []