mixpannenkoek 0.0.3 → 0.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: bc559cc6c5f4a55a318e78cfea0dd26fc5abcb8d
-  data.tar.gz: ba9b0af6737d9c8c4c7fbfdf7bd495ce53d0383d
+  metadata.gz: c522161ceeb1a1cb920c8df995fbbdc742a9afa8
+  data.tar.gz: 9700672e659aa9477cadc2ca4bfb4d4a2dcaafca
 SHA512:
-  metadata.gz: a3bcaaef791d0848be8bf5bfd31e0434ecd51d3318037655bc2892ab2e56177707a1077c1fb75750cda43bf6065c2b7360d402200e4e21c1a60e3965fd840cd7
-  data.tar.gz: 90a9757a0c9db3d992688481ae9d0acd76d5e2e2176809851715d367668948b9cdc24ee7ef606d0a5b3c6d4a56d8f208a4202648ff7824299cb16e7bb3441a10
+  metadata.gz: 14103a289695a37071c7f700705436665f95085d172477f885a8563f16b6d9c144dc54874ea3b435275842082854abb567ac4c03d3ef6cf5c5a19215790a12b0
+  data.tar.gz: 8cef5cadd63a7ecd662fba07f4154e8e17c41bc0f4dc576449ef529c08b7f90596cd59b36f72ffe79d4c7eda8a16dc8f66a69f8f30d7ad5feccdd196b53129f9

data/.travis.yml

@@ -0,0 +1,9 @@
+language: ruby
+rvm:
+  - 2.0.0
+  # - 1.9.3
+  # - 1.8.7
+  # - jruby-19mode
+  # - rubinius
+
+script: "bundle exec rspec"

data/CONTRIBUTORS.md

@@ -0,0 +1,3 @@
+## Contributors to mixpannenkoek
+* [Derek Kraan](https://github.com/derekkraan)
+* [Tim Flapper](https://github.com/timflapper)

data/README.md

@@ -1,6 +1,8 @@
 # Mixpannenkoek
 
-This gem implements a fluent query interface for the [mixpanel_client](https://github.com/keolo/mixpanel_client) gem.
+Mixpannenkoek implements a fluent query interface for Mixpanel. It uses the [mixpanel_client](https://github.com/keolo/mixpanel_client) gem.
+
+Read the [introductory blogpost](http://devblog.springest.com/introducing-mixpannenkoek).
 
 [![Code Climate](https://codeclimate.com/github/Springest/mixpannenkoek.png)](https://codeclimate.com/github/Springest/mixpannenkoek)
 
@@ -20,7 +22,7 @@ Or install it yourself as:
 
 ## Usage
 
-Begin by creating and configuring a model. In Rails you might place this in `app/models/conversion_funnel.rb`. You *must* set the api_key, api_secret, and endpoint. These properties are heritable, so in the following example, `OtherFunnel` will have the api_key, api_secret and endpoint already set.
+Begin by creating and configuring a model. In Rails you might place this in `app/models/funnel/conversions.rb`. You *must* set the api_key, api_secret, and endpoint. These properties are heritable, so in the following example, `Funnel::Conversions` will have the api_key, api_secret and endpoint set in `Funnel::Base`.
 
 ```ruby
 class Funnel::Base < Mixpannenkoek::Base
@@ -38,7 +40,7 @@ With mixpanel_client, you might run a query like this:
 
 ```ruby
 client = Mixpanel::Client.new(
-  api_key:    'MY_API_KEY', 
+  api_key:    'MY_API_KEY',
   api_secret: 'MY_API_SECRET'
 )
 
@@ -59,7 +61,7 @@ With mixpannenkoek, you would write it like this (making use of the models defin
 Funnel::Conversions.where(date: Date.parse('2014-01-01')..Date.parse('2014-01-31')).set(interval: 31).group('traffic_source').where(user_type: 'visitor').where(landing_page: 'homepage')
 ```
 
-`where` allows you to easily build the `where` parameter of the request.
+`where` and `where.not` allow you to easily build the `where` parameter of the request.
 
 `group` corresponds to the `on` parameter.
 
@@ -125,7 +127,7 @@ Funnel::Conversions.where(date: 31.days.ago..1.day.ago).response_data
       "goal"=>"View signup",
       "overall_conv_ratio"=>0.12362030905077263,
       "step_conv_ratio"=>0.12362030905077263}]}}
-      
+
 Funnel::Conversions.where(date: 31.days.ago..1.day.ago)['2010-05-24']['steps'][0]['count']
 #=> 762
 

data/lib/mixpannenkoek/query.rb

@@ -8,17 +8,23 @@ module Mixpannenkoek
 
     attr_accessor :where, :group, :klass
 
-    def initialize(klass, where = {}, vars = {}, group = nil)
+    def initialize(klass, where = {}, where_not = {}, vars = {}, group = nil)
       @where = where
+      @where_not = where_not
       @vars  = vars
       @group = group
       @klass = klass
     end
 
-    def where(condition)
+    def where(condition = nil)
+      return self if condition.nil?
       chain(where: @where.merge(condition))
     end
 
+    def not(condition)
+      chain(where_not: @where_not.merge(condition))
+    end
+
     def set(variable)
       chain(vars: @vars.merge(variable))
     end
@@ -56,26 +62,24 @@ module Mixpannenkoek
     def query
       query = @vars
 
-      if @where && @where != {}
+      if (@where && @where != {}) || (@where_not && @where_not != {})
+        query[:where] = []
+
         extract_dates(query, @where)
 
-        query[:where] = @where.map do |key,value|
-          next if key == :date
+        query[:where] += @where.map do |key,value|
+          where_clause(key, value)
+        end
 
-          case value
-          when Array
-            %Q((#{value.map { |val| %Q(properties["#{key}"] == "#{val}") }.join(' or ')}))
-          else
-            %Q(properties["#{key}"] == "#{value}")
-          end
-        end.compact
+        query[:where] += @where_not.map do |key,value|
+          where_not_clause(key, value)
+        end
 
-        query[:where] =
-          if query[:where]
-            query[:where].join(' and ')
-          else
-            nil
-          end
+        if query[:where].compact != []
+          query[:where] = query[:where].compact.join(' and ')
+        else
+          query.delete(:where)
+        end
       end
 
       query[:on] = %Q(properties["#{@group}"]) if @group
@@ -85,8 +89,8 @@ module Mixpannenkoek
 
     private
 
-    def chain(klass: @klass, where: @where, vars: @vars, group: @group)
-      self.class.new(klass, where, vars, group)
+    def chain(klass: @klass, where: @where, where_not: @where_not, vars: @vars, group: @group)
+      self.class.new(klass, where, where_not, vars, group)
     end
 
     def mixpanel_client
@@ -125,5 +129,20 @@ module Mixpannenkoek
       query[:from_date] = query[:from_date].strftime('%Y-%m-%d') if query[:from_date].respond_to? :strftime
       query[:to_date] = query[:to_date].strftime('%Y-%m-%d') if query[:to_date].respond_to? :strftime
     end
+
+    def where_clause(key, value, operator = '==', join = 'or')
+      return nil if key == :date
+
+      case value
+      when Array
+        %Q((#{value.map { |val| %Q(properties["#{key}"] #{operator} "#{val}") }.join(" #{join} ")}))
+      else
+        %Q(properties["#{key}"] #{operator} "#{value}")
+      end
+    end
+
+    def where_not_clause(key, value)
+      where_clause(key, value, '!=', 'and')
+    end
   end
 end

data/lib/mixpannenkoek/version.rb

@@ -1,3 +1,3 @@
 module Mixpannenkoek
-  VERSION = "0.0.3"
+  VERSION = "0.0.4"
 end

data/spec/lib/mixpannenkoek/query_spec.rb

@@ -57,6 +57,27 @@ describe Mixpannenkoek::Base do
     end
   end
 
+  describe '#where.not' do
+    subject { Mixpannenkoek::TestQuery.where(date: date_range).where.not(subject_name: 'Subject ABC').request_parameters[1] }
+    it 'sets :where' do
+      expect(subject).to include({ where: 'properties["subject_name"] != "Subject ABC"' })
+    end
+
+    context 'called twice' do
+      subject { Mixpannenkoek::TestQuery.where(date: date_range).where.not(subject_name: 'Subject ABC').where.not(training_name: 'Training XYZ').request_parameters[1] }
+      it 'sets multiple :where conditions' do
+        expect(subject).to include({ where: 'properties["subject_name"] != "Subject ABC" and properties["training_name"] != "Training XYZ"' })
+      end
+    end
+
+    context 'called with value: []' do
+      subject { Mixpannenkoek::TestQuery.where(date: date_range).where.not(subject_name: ['Subject ABC', 'Subject XYZ']).request_parameters[1] }
+      it 'sets multiple :where conditions' do
+        expect(subject).to include({ where: '(properties["subject_name"] != "Subject ABC" and properties["subject_name"] != "Subject XYZ")' })
+      end
+    end
+  end
+
   describe '#group' do
     subject { Mixpannenkoek::TestQuery.where(date: date_range).group('subject_name').request_parameters[1] }
     it 'sets :on' do
@@ -73,7 +94,7 @@ describe Mixpannenkoek::Base do
 
   describe '#set' do
     subject { Mixpannenkoek::TestQuery.set(funnel_id: 12345).where(date: date_range).request_parameters[1] }
-    it { should include({ funnel_id: 12345 }) }
+    it { expect(subject).to include({ funnel_id: 12345 }) }
 
     context 'called twice' do
       subject { Mixpannenkoek::TestQuery.set(funnel_id: 12345).set(event: 'click').where(date: date_range).request_parameters[1] }
@@ -92,7 +113,7 @@ describe Mixpannenkoek::Base do
 
     context 'missing api_key' do
       subject { Mixpannenkoek::TestQuery.where(date: date_range).to_hash }
-      before { Mixpannenkoek::TestQuery.stub(:api_key) { nil } }
+      before { allow(Mixpannenkoek::TestQuery).to receive(:api_key) { nil } }
       it 'raises Mixpannenkoek::Query::MissingConfiguration' do
         expect { subject }.to raise_error Mixpannenkoek::Query::MissingConfiguration, 'The mixpanel api_key has not been configured'
       end
@@ -100,7 +121,7 @@ describe Mixpannenkoek::Base do
 
     context 'missing api_secret' do
       subject { Mixpannenkoek::TestQuery.where(date: date_range).to_hash }
-      before { Mixpannenkoek::TestQuery.stub(:api_secret) { nil } }
+      before { allow(Mixpannenkoek::TestQuery).to receive(:api_secret) { nil } }
       it 'raises Mixpannenkoek::Query::MissingConfiguration' do
         expect { subject }.to raise_error Mixpannenkoek::Query::MissingConfiguration, 'The mixpanel api_secret has not been configured'
       end
@@ -111,7 +132,7 @@ describe Mixpannenkoek::Base do
     subject { Mixpannenkoek::TestQuery.where(date: date_range).results }
 
     let(:response_data) { JSON.parse(File.open("#{File.dirname(__FILE__)}/../../fixtures/funnel_response_data.json").read) }
-    before { Mixpanel::Client.any_instance.stub(:request).and_return(response_data) }
+    before { allow_any_instance_of(Mixpanel::Client).to receive(:request).and_return(response_data) }
 
     it 'returns a Mixpannenkoek::Results::Base object' do
       expect(subject).to be_a Mixpannenkoek::Results::Base
@@ -119,7 +140,7 @@ describe Mixpannenkoek::Base do
   end
 
   describe '#method_missing' do
-    before { Mixpanel::Client.any_instance.stub(:request).and_return({ "data" => { "2014-01-01" => [{ 'count' => '1' }, { 'count' => '4' }] } }) }
+    before { allow_any_instance_of(Mixpanel::Client).to receive(:request).and_return({ "data" => { "2014-01-01" => [{ 'count' => '1' }, { 'count' => '4' }] } }) }
     it 'delegates all calls to #results.send(*args)' do
       expect(Mixpannenkoek::TestQuery.where(date: date_range).keys).to eq ['2014-01-01']
     end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mixpannenkoek
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
 platform: ruby
 authors:
 - Derek Kraan
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-05-28 00:00:00.000000000 Z
+date: 2014-07-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: mixpanel_client
@@ -75,6 +75,8 @@ extensions: []
 extra_rdoc_files: []
 files:
 - .gitignore
+- .travis.yml
+- CONTRIBUTORS.md
 - Gemfile
 - LICENSE.txt
 - README.md