mixpanel_client 3.1.0 → 3.1.1

data/README.md

@@ -94,6 +94,9 @@ Create tag v2.0.2 and build and push mixpanel_client-2.0.2.gem to Rubygems
 
 ## Changelog
 
+### v3.1.1
+ * Avoid overriding the arg of client.request
+ * Allow retrieving the request_uri of a Mixpanel request
 
 ### v3.1.0
  * Parallel requests option.
@@ -149,6 +152,8 @@ Create tag v2.0.2 and build and push mixpanel_client-2.0.2.gem to Rubygems
 Feel free to add your name and link here.
 
 [Keolo Keagy](http://github.com/keolo) (Author)  
+[Hiroshige Umino](https://github.com/yaotti)
+[Gabor Ratky](https://github.com/rgabo)
 [Bill DeRusha](https://github.com/bderusha)  
 [Jason Logsdon](https://github.com/jasonlogsdon)  
 [James R](https://github.com/Cev)  

data/bin/autospec

@@ -0,0 +1,16 @@
+#!/usr/bin/env ruby
+#
+# This file was generated by Bundler.
+#
+# The application 'autospec' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require 'pathname'
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+require 'rubygems'
+require 'bundler/setup'
+
+load Gem.bin_path('rspec-core', 'autospec')

data/bin/htmldiff

@@ -0,0 +1,16 @@
+#!/usr/bin/env ruby
+#
+# This file was generated by Bundler.
+#
+# The application 'htmldiff' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require 'pathname'
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+require 'rubygems'
+require 'bundler/setup'
+
+load Gem.bin_path('diff-lcs', 'htmldiff')

data/bin/ldiff

@@ -0,0 +1,16 @@
+#!/usr/bin/env ruby
+#
+# This file was generated by Bundler.
+#
+# The application 'ldiff' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require 'pathname'
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+require 'rubygems'
+require 'bundler/setup'
+
+load Gem.bin_path('diff-lcs', 'ldiff')

data/bin/rake

@@ -0,0 +1,16 @@
+#!/usr/bin/env ruby
+#
+# This file was generated by Bundler.
+#
+# The application 'rake' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require 'pathname'
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+require 'rubygems'
+require 'bundler/setup'
+
+load Gem.bin_path('rake', 'rake')

data/bin/ri

@@ -0,0 +1,16 @@
+#!/usr/bin/env ruby
+#
+# This file was generated by Bundler.
+#
+# The application 'ri' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require 'pathname'
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+require 'rubygems'
+require 'bundler/setup'
+
+load Gem.bin_path('rdoc', 'ri')

data/bin/rspec

@@ -0,0 +1,16 @@
+#!/usr/bin/env ruby
+#
+# This file was generated by Bundler.
+#
+# The application 'rspec' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require 'pathname'
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+require 'rubygems'
+require 'bundler/setup'
+
+load Gem.bin_path('rspec-core', 'rspec')

data/lib/mixpanel/client.rb

@@ -46,8 +46,7 @@ module Mixpanel
     # @options  [Hash] options variables used to make a specific request for mixpanel data
     # @return   [JSON, String] mixpanel response as a JSON object or CSV string
     def request(resource, options)
-      @format = options[:format] || :json
-      @uri = URI.mixpanel(resource, normalize_options(options))
+      @uri = request_uri(resource, options)
       if @parallel
         parallel_request = prepare_parallel_request
         hydra.queue parallel_request
@@ -59,6 +58,28 @@ module Mixpanel
       end
     end
 
+    # Return mixpanel URI to the data
+    #
+    # @example
+    #   uri = client.request_uri('events/properties', {
+    #     event:    '["test-event"]',
+    #     name:     'hello',
+    #     values:   '["uno", "dos"]',
+    #     type:     'general',
+    #     unit:     'hour',
+    #     interval:  24,
+    #     limit:     5,
+    #     bucket:   'contents'
+    #   })
+    #
+    # @resource [String] mixpanel api resource endpoint
+    # @options  [Hash] options variables used to make a specific request for mixpanel data
+    # @return   [JSON, String] mixpanel response as a JSON object or CSV string
+    def request_uri(resource, options)
+      @format = options[:format] || :json
+      URI.mixpanel(resource, normalize_options(options))
+    end
+
     def prepare_parallel_request
       request = ::Typhoeus::Request.new(@uri)
       request.on_complete do |response|
@@ -91,11 +112,12 @@ module Mixpanel
     #
     # @return [Hash] collection of options including defaults and generated signature
     def normalize_options(options)
-      options.merge!(
+      normalized_options = options.dup
+      normalized_options.merge!(
         :format  => @format,
         :api_key => @api_key,
         :expire  => Time.now.to_i + 600 # Grant this request 10 minutes
-      ).merge!(:sig => Utils.generate_signature(options, @api_secret))
+      ).merge!(:sig => Utils.generate_signature(normalized_options, @api_secret))
     end
 
     def self.base_uri_for_resource(resource)

data/lib/mixpanel/version.rb

@@ -10,6 +10,6 @@ module Mixpanel
   # Return metrics from Mixpanel Data API
   class Client
     # Mixpanel::Client library version
-    VERSION = '3.1.0'
+    VERSION = '3.1.1'
   end
 end

data/spec/mixpanel_client/mixpanel_client_spec.rb

@@ -59,6 +59,16 @@ describe Mixpanel::Client do
       data.should == {"events"=>[], "type"=>"general"}
     end
 
+    it 'does not modify the provided options' do
+      options = { foo: 'bar' }
+      # Stub Mixpanel request
+      stub_request(:get, /^#{@uri}.*/).to_return(:body => '{"events": [], "type": "general"}')
+      expect {
+        @client.request('events/top', options)
+      }.to_not change { options }
+    end
+
+
     context "with parallel option enabled" do
       before :all do
         @parallel_client = Mixpanel::Client.new(:api_key => 'test_key', :api_secret => 'test_secret', :parallel => true)

metadata

@@ -1,142 +1,95 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: mixpanel_client
-version: !ruby/object:Gem::Version 
-  hash: 3
+version: !ruby/object:Gem::Version
+  version: 3.1.1
   prerelease: 
-  segments: 
-  - 3
-  - 1
-  - 0
-  version: 3.1.0
 platform: ruby
-authors: 
+authors:
 - Keolo Keagy
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2013-02-05 00:00:00 Z
-dependencies: 
-- !ruby/object:Gem::Dependency 
-  name: json
-  prerelease: false
-  requirement: &id001 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - ~>
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 1
-        - 6
-        version: "1.6"
-  type: :runtime
-  version_requirements: *id001
-- !ruby/object:Gem::Dependency 
+date: 2013-08-30 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
   name: typhoeus
-  prerelease: false
-  requirement: &id002 !ruby/object:Gem::Requirement 
+  requirement: &70281989507260 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
+    requirements:
     - - ~>
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        - 5
-        - 4
+      - !ruby/object:Gem::Version
         version: 0.5.4
   type: :runtime
-  version_requirements: *id002
-- !ruby/object:Gem::Dependency 
-  name: bundler
   prerelease: false
-  requirement: &id003 !ruby/object:Gem::Requirement 
+  version_requirements: *70281989507260
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: &70281989506700 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 11
-        segments: 
-        - 1
-        - 2
-        version: "1.2"
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '1.2'
   type: :development
-  version_requirements: *id003
-- !ruby/object:Gem::Dependency 
-  name: rake
   prerelease: false
-  requirement: &id004 !ruby/object:Gem::Requirement 
+  version_requirements: *70281989506700
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: &70281989506160 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 11
-        segments: 
-        - 0
-        - 9
-        - 2
-        - 2
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
         version: 0.9.2.2
   type: :development
-  version_requirements: *id004
-- !ruby/object:Gem::Dependency 
-  name: rdoc
   prerelease: false
-  requirement: &id005 !ruby/object:Gem::Requirement 
+  version_requirements: *70281989506160
+- !ruby/object:Gem::Dependency
+  name: rdoc
+  requirement: &70281989505660 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 17
-        segments: 
-        - 3
-        - 11
-        version: "3.11"
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '3.11'
   type: :development
-  version_requirements: *id005
-- !ruby/object:Gem::Dependency 
-  name: rspec
   prerelease: false
-  requirement: &id006 !ruby/object:Gem::Requirement 
+  version_requirements: *70281989505660
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &70281989505140 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 27
-        segments: 
-        - 2
-        - 5
-        - 0
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
         version: 2.5.0
   type: :development
-  version_requirements: *id006
-- !ruby/object:Gem::Dependency 
-  name: webmock
   prerelease: false
-  requirement: &id007 !ruby/object:Gem::Requirement 
+  version_requirements: *70281989505140
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: &70281989504660 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 51
-        segments: 
-        - 1
-        - 9
-        - 0
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
         version: 1.9.0
   type: :development
-  version_requirements: *id007
+  prerelease: false
+  version_requirements: *70281989504660
 description: Simple ruby client interface to the Mixpanel API.
-email: 
+email:
 - keolo@dreampointmedia.com
-executables: []
-
+executables:
+- autospec
+- htmldiff
+- ldiff
+- rake
+- ri
+- rspec
 extensions: []
-
 extra_rdoc_files: []
-
-files: 
+files:
 - .document
 - .gitignore
 - .rvmrc
@@ -144,6 +97,12 @@ files:
 - LICENSE
 - README.md
 - Rakefile
+- bin/autospec
+- bin/htmldiff
+- bin/ldiff
+- bin/rake
+- bin/ri
+- bin/rspec
 - config/mixpanel.template.yml
 - lib/mixpanel/client.rb
 - lib/mixpanel/exceptions.rb
@@ -161,38 +120,29 @@ files:
 - spec/spec_helper.rb
 homepage: http://github.com/keolo/mixpanel_client
 licenses: []
-
 post_install_message: 
 rdoc_options: []
-
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
+required_ruby_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
-      version: "0"
-required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
-      version: "0"
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
 requirements: []
-
 rubyforge_project: mixpanel_client
 rubygems_version: 1.8.15
 signing_key: 
 specification_version: 3
 summary: Ruby Mixpanel API Client Library
-test_files: 
+test_files:
 - spec/mixpanel_client/events_externalspec.rb
 - spec/mixpanel_client/mixpanel_client_spec.rb
 - spec/mixpanel_client/properties_externalspec.rb