gamifier 1.0.8 → 1.1.0

data/spec/unit/engine_spec.rb

@@ -23,37 +23,112 @@ describe Gamifier::Engine do
   end
 
   describe "#uri_to" do
+
     it "should correctly concatenate URIs" do
       @engine.uri_to.to_s.should == "http://somewhere.ltd/path/1234/"
       @engine.uri_to("resource").to_s.should == "http://somewhere.ltd/path/1234/resource"
       @engine.uri_to("/resource").to_s.should == "http://somewhere.ltd/resource"
       @engine.uri_to("../resource").to_s.should == "http://somewhere.ltd/path/resource"
     end
+
   end
 
   describe "configuration" do
+
     before do
       @engine = Gamifier::Engine.new(:key => "new-key")
     end
+
     it "should overwrite the global configuration with the given parameters at intialization time" do
       @engine.config.should == {:uri => "http://somewhere.ltd/path/", :key => "new-key"}
       Gamifier.config.should == {:uri => "http://somewhere.ltd/path/", :key => "1234"}
     end
 
     describe "#ok?" do
-      it "should be true" do
-        @engine.should be_ok
-      end
 
-      it "should be false if the key is missing" do
-        @engine.config[:key] = ""
-        @engine.should_not be_ok
+      subject { @engine.ok? }
+
+      context "with enterprise_key" do
+
+        before do
+          @engine.config[:key] = ''
+          @engine.config[:enterprise_key] = '5678'
+        end
+
+        context "with uri" do
+
+          before do
+            @engine.config[:uri] = 'http://foo.com'
+          end
+
+          it { should be_true }
+
+        end
+
+        context "without uri" do
+
+          before do
+            @engine.config[:uri] = ''
+          end
+
+          it { should_not be_true }
+
+        end
+
       end
 
-      it "should be false if the uri is missing" do
-        @engine.config[:uri] = ""
-        @engine.should_not be_ok
+      context "without enterprise_key" do
+
+        before do
+          @engine.config[:enterprise_key] = ''
+        end
+
+        context "with key and uri" do
+
+          before do
+            @engine.config[:key] = '1234'
+            @engine.config[:uri] = 'http://foo.com'
+          end
+
+          it { should be_true }
+
+        end
+
+        context "with key" do
+
+          before do
+            @engine.config[:key] = '1234'
+            @engine.config[:uri] = ''
+          end
+
+          it { should_not be_true }
+
+        end
+
+        context "with uri" do
+
+          before do
+            @engine.config[:key] = ''
+            @engine.config[:uri] = 'http://foo.com'
+          end
+
+          it { should_not be_true }
+
+        end
+
+        context "without key and uri" do
+
+          before do
+            @engine.config[:key] = ''
+            @engine.config[:uri] = ''
+          end
+
+          it { should_not be_true }
+
+        end
+
       end
+
     end
 
   end
@@ -71,26 +146,31 @@ describe Gamifier::Engine do
   end
 
   describe "#transmit" do
+
     it "transmits POST requests to the API" do
       stub_request(:post, "http://somewhere.ltd/path/1234/resource.json").
         with(:body => {:a => "b", :c => ["d", "e"]}, :headers => { 'Content-Type' => 'application/x-www-form-urlencoded' })
       @engine.transmit :post, "resource", :body => {"a" => "b", :c => ["d", "e"]}
     end
+
     it "transmits GET requests to the API" do
       stub_request(:get, "http://somewhere.ltd/path/1234/resource.json").
         with(:query => {"limit" => "5"})
       @engine.transmit :get, "resource", :query => {"limit" => "5"}
     end
+
     it "should return true if the response is 204" do
       stub_request(:get, "http://somewhere.ltd/resource.json").
         to_return(:status => 204)
       @engine.transmit(:get, "/resource").should be_true
     end
+
     it "should return the parsed response if the status is in the 2xx range (except 204)" do
       stub_request(:get, "http://somewhere.ltd/resource.json").
         to_return(:body => JSON.dump(site), :headers => {'Content-Type' => 'application/json;charset=utf-8'})
       @engine.transmit(:get, "/resource").should == site
     end
+
     [:get, :head].each do |method|
       it "should return nil if the response status is 422 (Unprocessable Entity) and method is #{method}" do
         stub_request(method, "http://somewhere.ltd/resource.json").
@@ -98,6 +178,7 @@ describe Gamifier::Engine do
         @engine.transmit(method, "/resource").should be_nil
       end
     end
+
     [:delete, :post, :put].each do |method|
       it "should return false if the response status is 422 (Unprocessable Entity) and method is #{method}" do
         stub_request(method, "http://somewhere.ltd/resource.json").
@@ -105,11 +186,13 @@ describe Gamifier::Engine do
         @engine.transmit(method, "/resource").should be_false
       end
     end
+
     it "should return nil if the response status is 404" do
       stub_request(:get, "http://somewhere.ltd/resource.json").
         to_return(:status => 404)
       @engine.transmit(:get, "/resource").should be_nil
     end
+
     it "should raise an HTTPServerError for a 5xx code" do
       stub_request(:get, "http://somewhere.ltd/resource.json").
         to_return(:status => 500)
@@ -117,6 +200,7 @@ describe Gamifier::Engine do
         @engine.transmit(:get, "/resource")
       }.to raise_error Gamifier::HTTPServerError
     end
+
     it "should raise an HTTPClientError for a 4xx code" do
       stub_request(:get, "http://somewhere.ltd/resource.json").
         to_return(:status => 400)
@@ -124,14 +208,17 @@ describe Gamifier::Engine do
         @engine.transmit(:get, "/resource")
       }.to raise_error Gamifier::HTTPClientError
     end
+
   end
 
   describe "collections" do
+
     %w{activities activity_definitions groups players rewards reward_definitions sites units users}.each do |collection|
       it "should respond ##{collection}" do
         @engine.should respond_to(collection.to_sym)
       end
     end
+
     it "should instantiate a new collection object with the correct model" do
       collection = @engine.players
       collection.should be_a(Gamifier::Collection)
@@ -140,4 +227,5 @@ describe Gamifier::Engine do
     end
 
   end
-end
+
+end

data/spec/unit/gamifier_spec.rb

@@ -8,18 +8,18 @@ describe Gamifier do
 
   it "should allow to set the API URI" do
     Gamifier.set :uri, "http://somwhere.ltd"
-    Gamifier.config[:uri].should == "http://somwhere.ltd"
+    Gamifier.config[:uri].should eq "http://somwhere.ltd"
   end
 
   it "should allow to set the API KEY" do
     Gamifier.set :key, "1234"
-    Gamifier.config[:key].should == "1234"
+    Gamifier.config[:key].should eq "1234"
   end
 
   it "should allow to set multiple configuration options at once" do
     Gamifier.set :uri => "http://somewhere.ltd", "key" => "1234"
-    Gamifier.config[:uri].should == "http://somewhere.ltd"
-    Gamifier.config[:key].should == "1234"
+    Gamifier.config[:uri].should eq "http://somewhere.ltd"
+    Gamifier.config[:key].should eq "1234"
   end
 
   it "should allow to reset the state" do
@@ -31,10 +31,11 @@ describe Gamifier do
   it "should accept a logger object" do
     logger = mock("logger")
     Gamifier.logger = logger
-    Gamifier.logger.should == logger    
+    Gamifier.logger.should eq logger
   end
 
   describe "with proper configuration" do
+
     before do
       Gamifier.set :uri => "http://somewhere.ltd/path/", :key => "1234"
     end
@@ -48,13 +49,14 @@ describe Gamifier do
     it "should return an instance of Gamifier::Engine" do
       Gamifier.engine.should be_instance_of(Gamifier::Engine)
     end
-    
+
     it "should create a new engine object after reset" do
       engine = Gamifier.engine
       Gamifier.reset!
       Gamifier.set :uri => "http://somewhere.ltd/path/", :key => "1234"
       Gamifier.engine.should_not be_equal(engine)
     end
+
   end
 
-end
+end

data/spec/unit/model_spec.rb

@@ -1,6 +1,7 @@
 require 'spec_helper'
 
 describe Gamifier::Model do
+
   def raw_find
     '{"data":{"name":null,"created_at":"2012-05-31T04:59:22-07:00","email":"1234@dimelo.com","_id":"4fc75d1a3dc648153b006183"},"paging":null}'
   end
@@ -31,6 +32,7 @@ describe Gamifier::Model do
   end
 
   describe "model instances" do
+
     before do
       @model = Gamifier::Model.new :x => "y", :a => "b"
     end
@@ -69,50 +71,63 @@ describe Gamifier::Model do
     end
 
     describe "existing model" do
+
       before do
         @model.stub!(:new?).and_return false
         @model.stub!(:path).and_return("models/1234")
       end
+
       it "should save itself using PUT if not new" do
         @model.engine.should_receive(:transmit).with(:put, "models/1234", :body => {"model" => hash_including(:x => "y")})
         @model.save
       end
+
       it "should destroy itself using DELETE if not new" do
         @model.engine.should_receive(:transmit).with(:delete, "models/1234")
         @model.destroy
       end
+
       it "should update the model with the given attributes" do
         @model.engine.should_receive(:transmit).with(:put, "models/1234", :body => {"model" => {:key => "value"}})
         @model.update_attributes(:key => "value")
       end
+
     end
 
     describe "new model" do
+
       before do
         @model.stub!(:new?).and_return true
       end
+
       it "should save itself using POST if new" do
         @model.engine.should_receive(:transmit).with(:post, "models", :body => {"model" => hash_including(:x => "y")})
         @model.save
       end
+
       it "should return true if destroying and new" do
         @model.destroy.should be_true
       end
+
       it "should raise an error if trying to call update_attributes" do
         expect{ @model.update_attributes(:key => "value") }.to raise_error(Gamifier::Error)
       end
+
     end
 
     describe "#payload_for_submission" do
+
       it "should reject any attribute not in the list of the mutable_attributes (if any)" do
         @model.class.mutable_attributes :last_name
         @model.first_name = "hello"
         @model.last_name = "world"
         @model.payload_for_submission.should == {"model" => {:last_name => "world"}}
       end
+
     end
 
     describe "replace_if_successful" do
+
       it "should replace the attributes if res is a Hash and has a 'data' key" do
         @model.replace_if_successful(JSON.parse(raw_create)).should == @model
         @model._id.should == "4fc7661f49f83857cd006044"
@@ -123,33 +138,41 @@ describe Gamifier::Model do
           @model.replace_if_successful(value).should == value
         end
       end
+
     end
 
   end
 
   describe "FinderMethods" do
+
     before do
       @engine = mock(Gamifier::Engine)
       @collection = Gamifier::Collection.new(@engine, Gamifier::Model)
     end
+
     describe "all" do
+
       it "should issue a get request with no params" do
         @engine.should_receive(:transmit).with(:get, "models", :query => {:page => 1, :per_page => 50})
         @collection.all
       end
+
       it "should issue a get request with the given params" do
         @engine.should_receive(:transmit).with(:get, "models", :query => {:page => 1, :per_page => 50, :limit => 5})
         @collection.all :limit => 5
       end
+
       it "should return a list of entries" do
         @engine.should_receive(:transmit).and_return({'data' => [{'key' => 'value1'}, {'key' => 'value2'}]})
         entries = @collection.all
         entries.length.should == 2
         entries.all?{|e| e.kind_of?(Gamifier::Model)}.should be_true
       end
+
     end
 
     describe "find" do
+
       it "should return the first entry if data is returned" do
         @engine.should_receive(:transmit).with(:get, "models/1234@dimelo.com", :query => {}).
           and_return JSON.parse(raw_find)
@@ -157,12 +180,15 @@ describe Gamifier::Model do
         user.should be_a(Gamifier::Model)
         user._id.should == "4fc75d1a3dc648153b006183"
       end
+
     end
 
     describe "find_by_name" do
+
       before do
         @raw_payload = '{"data":[{"name":"karma","label":"Karma","normalized_name":"unit_karma","type":"point","abbreviation":"kar","display_priority":0},{"name":"yoh","label":"Yoh","normalized_name":"unit_yoh","type":"point","abbreviation":"yoh","display_priority":0},{"name":"karma","label":"Karma","normalized_name":"unit_karma","type":"point","abbreviation":"kar","display_priority":0}],"paging":{}}'
       end
+
       it "should return the first entry if a matching entry can be found" do
         @engine.should_receive(:transmit).with(:get, "models", instance_of(Hash)).
           and_return JSON.parse(@raw_payload)
@@ -170,13 +196,16 @@ describe Gamifier::Model do
         entry.should be_a(Gamifier::Model)
         entry.label.should == "Karma"
       end
+
       it "should return nil if no entry can be found" do
         @engine.should_receive(:transmit).with(:get, "models", instance_of(Hash)).
           and_return JSON.parse('{"data": [], "paging": {}}')
         entry = @collection.find_by_name("karma")
         entry.should be_nil
       end
+
     end
 
   end
+
 end

data/spec/unit/models/activity_definition_spec.rb

@@ -10,9 +10,9 @@ describe Gamifier::Player do
 
     subject { Gamifier::ActivityDefinition.new.limit(1, 24.0) }
 
-    it { subject.enable_rate_limiting.should be_true }
-    it { subject.bucket_max_capacity.should == 1 }
-    it { subject.bucket_drain_rate.should == 1 / 24.0 }
+    its(:enable_rate_limiting) { should be_true }
+    its(:bucket_max_capacity) { should eq(1) }
+    its(:bucket_drain_rate) { should eq(1 / 24.0) }
 
   end
 
@@ -20,9 +20,9 @@ describe Gamifier::Player do
 
     subject { Gamifier::ActivityDefinition.new.limit_per_day(1) }
 
-    it { subject.enable_rate_limiting.should be_true }
-    it { subject.bucket_max_capacity.should == 1 }
-    it { subject.bucket_drain_rate.should == 1 / 24.0 }
+    its(:enable_rate_limiting) { should be_true }
+    its(:bucket_max_capacity) { should eq(1) }
+    its(:bucket_drain_rate) { should eq(1 / 24.0) }
 
   end
 
@@ -30,9 +30,9 @@ describe Gamifier::Player do
 
     subject { Gamifier::ActivityDefinition.new.limit_per_week(1) }
 
-    it { subject.enable_rate_limiting.should be_true }
-    it { subject.bucket_max_capacity.should == 1 }
-    it { subject.bucket_drain_rate.should == 1 / (24.0 * 7.0) }
+    its(:enable_rate_limiting) { should be_true }
+    its(:bucket_max_capacity) { should eq(1) }
+    its(:bucket_drain_rate) { should eq(1 / (24.0 * 7.0)) }
 
   end
 
@@ -40,9 +40,9 @@ describe Gamifier::Player do
 
     subject { Gamifier::ActivityDefinition.new.limit_once_per_day }
 
-    it { subject.enable_rate_limiting.should be_true }
-    it { subject.bucket_max_capacity.should == 1 }
-    it { subject.bucket_drain_rate.should == 1 / 24.0 }
+    its(:enable_rate_limiting) { should be_true }
+    its(:bucket_max_capacity) { should eq(1) }
+    its(:bucket_drain_rate) { should eq(1 / 24.0) }
 
   end
 
@@ -50,9 +50,9 @@ describe Gamifier::Player do
 
     subject { Gamifier::ActivityDefinition.new.limit_once_per_week }
 
-    it { subject.enable_rate_limiting.should be_true }
-    it { subject.bucket_max_capacity.should == 1 }
-    it { subject.bucket_drain_rate.should == 1 / (24.0 * 7.0) }
+    its(:enable_rate_limiting) { should be_true }
+    its(:bucket_max_capacity) { should eq(1) }
+    its(:bucket_drain_rate) { should eq(1 / (24.0 * 7.0)) }
 
   end
 

data/spec/unit/models/player_spec.rb

@@ -1,15 +1,16 @@
 require 'spec_helper'
 
 describe Gamifier::Player do
-  before do
-    @engine = mock(Gamifier::Engine)
-  end
+
+  let(:engine) { mock(Gamifier::Engine) }
+
   describe "crediting" do
+
     it "should create a new activity and save it" do
       player = Gamifier::Player.new(:_id => "1234")
-      player.engine = @engine
+      player.engine = engine
 
-      @engine.should_receive(:activities).
+      engine.should_receive(:activities).
         and_return(collection = mock(Gamifier::Collection))
       collection.should_receive(:build).
         with(:data1 => "value", :player_id => "1234", :verb => "event").
@@ -17,11 +18,13 @@ describe Gamifier::Player do
 
       player.credit('event', :data1 => "value").should == true
     end
+
   end
-  
+
   describe "FinderMethods" do
+
     before do
-      @collection = Gamifier::Collection.new(@engine, Gamifier::Player)
+      @collection = Gamifier::Collection.new(engine, Gamifier::Player)
     end
 
     it "should have included all the methods" do
@@ -31,21 +34,25 @@ describe Gamifier::Player do
     end
 
     describe "find_by_site_and_email" do
+
       it "should issue a get request with the correct params" do
-        @engine.should_receive(:transmit).with(:get, "players", :query => {:site=>"test.ltd", :email=>"hi@hello.com", :limit => 5})
+        engine.should_receive(:transmit).with(:get, "players", :query => {:site=>"test.ltd", :email=>"hi@hello.com", :limit => 5})
         @collection.find_by_site_and_email 'test.ltd', 'hi@hello.com', :limit => 5
       end
+
     end
-    
+
     describe "find_by_player_id" do
-      
+
       let(:player_id) { '123456789' }
-      
+
       it "should issue a get request with the correct params" do
-        @engine.should_receive(:transmit).with(:get, "players/#{player_id}")
+        engine.should_receive(:transmit).with(:get, "players/#{player_id}")
         @collection.find_by_player_id(player_id)
       end
-      
+
     end
+
   end
-end
+
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: gamifier
 version: !ruby/object:Gem::Version
-  version: 1.0.8
+  version: 1.1.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-10-03 00:00:00.000000000 Z
+date: 2013-02-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -99,6 +99,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - .gitignore
+- .rspec
 - Gemfile
 - LICENSE
 - README.md
@@ -109,6 +110,7 @@ files:
 - lib/gamifier.rb
 - lib/gamifier/collection.rb
 - lib/gamifier/dsl.rb
+- lib/gamifier/dsl/api_key.rb
 - lib/gamifier/dsl/network.rb
 - lib/gamifier/dsl/site.rb
 - lib/gamifier/engine.rb
@@ -116,7 +118,9 @@ files:
 - lib/gamifier/model.rb
 - lib/gamifier/models/activity.rb
 - lib/gamifier/models/activity_definition.rb
+- lib/gamifier/models/api_key.rb
 - lib/gamifier/models/group.rb
+- lib/gamifier/models/network.rb
 - lib/gamifier/models/player.rb
 - lib/gamifier/models/reward.rb
 - lib/gamifier/models/reward_definition.rb
@@ -132,6 +136,7 @@ files:
 - spec/spec_helper.rb
 - spec/spec_integration_helper.rb
 - spec/unit/collection_spec.rb
+- spec/unit/dsl/api_key_spec.rb
 - spec/unit/dsl/network_spec.rb
 - spec/unit/dsl/site_spec.rb
 - spec/unit/dsl_spec.rb
@@ -172,6 +177,7 @@ test_files:
 - spec/spec_helper.rb
 - spec/spec_integration_helper.rb
 - spec/unit/collection_spec.rb
+- spec/unit/dsl/api_key_spec.rb
 - spec/unit/dsl/network_spec.rb
 - spec/unit/dsl/site_spec.rb
 - spec/unit/dsl_spec.rb