checkdin 0.2.7 → 0.2.8

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    checkdin (0.2.6)
+    checkdin (0.2.7)
       activesupport (>= 2.0.3)
       faraday (~> 0.8)
       faraday_middleware

data/lib/checkdin/activities.rb

@@ -14,6 +14,7 @@ module Checkdin
     #
     # @param [Hash]  options
     # @option options Integer :campaign_id - Only return won rewards for this campaign.
+    # @option options String  :classification - Only return activities for users in this classification.
     # @option options Integer :user_id - Only return won rewards for this user.
     # @option options Integer :since - Only fetch updates since this time (UNIX timestamp)
     # @option options Integer :limit - The maximum number of records to return.

data/lib/checkdin/leaderboard.rb

@@ -14,5 +14,16 @@ module Checkdin
       return_error_or_body(response)
     end
 
+    # Get the classification leaderboard for a given campaign
+    #
+    # param [Integer] campaign_id The ID of the campaign to fetch the leaderboard for.
+
+    def classification_leaderboard(campaign_id)
+      response = connection.get do |req|
+        req.url "campaigns/#{campaign_id}/classification_leaderboard"
+      end
+      return_error_or_body(response)
+    end
+
   end
 end

data/lib/checkdin/user_bridge.rb

@@ -30,7 +30,6 @@ module Checkdin
 
       @checkdin_landing_url = options.delete(:checkdin_landing_url) || CHECKDIN_DEFAULT_LANDING
 
-      raise ArgumentError.new("Unknown arguments given: #{options.keys.inspect}") unless options.empty?
     end
 
     # Public: Build a full signed url for logging a specific user into checkd.in. Notice:
@@ -42,15 +41,25 @@ module Checkdin
     #   user_identifier       - REQUIRED, your unique identifier for the user, MUST NOT change over time.
     #   authentication_action - OPTIONAL, the given action will be performed immediately,
     #                           and the user redirected back to your site afterwards.
+    #   referral_token        - OPTIONAL, the referral token of the user that referred the user being created.
+    #   first_name            - OPTIONAL
+    #   last_name             - OPTIONAL
+    #   gender                - OPTIONAL, format of male or female
+    #   birth_date            - OPTIONAL, YYYY-MM-DD format
+    #   username              - OPTIONAL
+    #   mobile_number         - OPTIONAL, XXXYYYZZZZ format
+    #   postal_code_text      - OPTIONAL, XXXXX format
+    #   classification        - OPTIONAL, the internal group or classification a user belongs to
+    #   delivery_email        - OPTIONAL, whether a user should receive email notifications
+    #   delivery_sms          - OPTIONAL, whether a user should receive sms notifications
     #
     # Returns a URL you can use for redirecting a user. Notice this will expire, so it should
     # be generated and used only when a user actually wants to log into checkd.in.
     def login_url options
       email                 = options.delete(:email)           or raise ArgumentError.new("No :email passed for user")
       user_identifier       = options.delete(:user_identifier) or raise ArgumentError.new("No :user_identifier passed for user")
-      authentication_action = options.delete(:authentication_action)
 
-      authenticated_parameters = build_authenticated_parameters(email, user_identifier, authentication_action)
+      authenticated_parameters = build_authenticated_parameters(email, user_identifier, options)
 
       [checkdin_landing_url, authenticated_parameters.to_query].join
     end
@@ -58,22 +67,22 @@ module Checkdin
     # Private: Build a signed hash of parameters for redirecting the user to checkd.in.
     #
     # Returns a hash including a secure message digest and the current timestamp
-    def build_authenticated_parameters email, user_identifier, authentication_action = nil
-      build_request(email, user_identifier, authentication_action).tap do |request|
+    def build_authenticated_parameters email, user_identifier, options
+      build_request(email, user_identifier, options).tap do |request|
         request['digest'] = digest_request(request)
       end
     end
 
     private
-    def build_request email, user_identifier, authentication_action
+    def build_request email, user_identifier, options
+      stringified_options = stringify_keys(options)
+
       {
         'auth_timestamp' => Time.now.to_i,
         'client_id'      => client_identifier,
         'client_uid'     => user_identifier,
         'email'          => email,
-      }.tap do |request|
-        request['authentication_action'] = authentication_action if authentication_action
-      end
+      }.merge(stringified_options)
     end
 
     def digest_request request
@@ -81,5 +90,11 @@ module Checkdin
       OpenSSL::HMAC.hexdigest(OpenSSL::Digest::SHA256.new, bridge_secret, encoded_request)
     end
 
+    def stringify_keys hash
+      hash.inject({}) do |options, (key, value)|
+        options[key.to_s] = value
+        options
+      end
+    end
   end
 end

data/lib/checkdin/users.rb

@@ -34,8 +34,19 @@ module Checkdin
     # Create a user in the checkd.in system tied to the authenticating client.
     #
     # @param [Hash]  options
-    # @option options String :identifier - The authenticating client's internal identifier for this user.
-    # @option options String :email - A valid email for the user
+    # @option options String :identifier            - REQUIRED, The authenticating client's internal identifier for this user.
+    # @option options String :email                 - REQUIRED, A valid email for the user
+    # @option options String :referral_token        - OPTIONAL, the referral token of the user that referred the user being created.
+    # @option options String :first_name            - OPTIONAL
+    # @option options String :last_name             - OPTIONAL
+    # @option options String :gender                - OPTIONAL, format of male or female
+    # @option options String :birth_date            - OPTIONAL, YYYY-MM-DD format
+    # @option options String :username              - OPTIONAL
+    # @option options String :mobile_number         - OPTIONAL, XXXYYYZZZZ format
+    # @option options String :postal_code_text      - OPTIONAL, XXXXX format
+    # @option options String :classification        - OPTIONAL, the internal group or classification a user belongs to
+    # @option options String :delivery_email        - OPTIONAL, whether a user should receive email notifications
+    # @option options String :delivery_sms          - OPTIONAL, whether a user should receive sms notifications
 
     def create_user(options={})
       response = connection.post do |req|

data/lib/checkdin/version.rb

@@ -1,3 +1,3 @@
 module Checkdin
-  VERSION = '0.2.7'
+  VERSION = '0.2.8'
 end

data/spec/checkdin/leaderboard_spec.rb

@@ -15,4 +15,14 @@ describe Checkdin::Leaderboard do
       result.leaders.count.should == 5
     end
   end
+
+  context "viewing a leaderboard for a campaign's classifications" do
+    use_vcr_cassette
+    let(:result) { @client.classification_leaderboard(35) }
+
+    it "should provide a list of classifications" do
+      result.classifications.first.classification.should == "grouped"
+      result.classifications.first.total_points.should == 10
+    end
+  end
 end

data/spec/checkdin/user_bridge_spec.rb

@@ -24,10 +24,10 @@ describe Checkdin::UserBridge, 'constructor' do
     instance.checkdin_landing_url.should == landing_url
   end
 
-  it "raises an error on unknown arguments" do
+  it "does not raise an error on unknown arguments" do
     expect do
       Checkdin::UserBridge.new(default_options.merge(:misspelled_option => 'error me'))
-    end.to raise_error(ArgumentError, /misspelled_option/)
+    end.to_not raise_error(ArgumentError, /misspelled_option/)
   end
 end
 
@@ -35,14 +35,16 @@ describe Checkdin::UserBridge, '#login_url' do
   let(:instance) { Checkdin::UserBridge.new(:client_identifier    => client_identifier,
                                             :bridge_secret        => bridge_secret,
                                             :checkdin_landing_url => checkdin_landing_url) }
-  subject { instance.login_url(:email                 => user_email,
-                               :user_identifier       => user_identifier,
-                               :authentication_action => authentication_action) }
+  subject { instance.login_url(options) }
+  let(:options) { default_options }
+  let(:default_options) {{
+    :email           => user_email,
+    :user_identifier => user_identifier
+  }}
   let(:client_identifier) { 'client-1704' }
   let(:bridge_secret) { '123-shared-secret' }
   let(:user_email) { 'bob@example.com' }
   let(:user_identifier) { '17-batch1-bob' }
-  let(:authentication_action) { nil }
   let(:checkdin_landing_url) { nil }
   let(:timestamp) { 1325605589 }
 
@@ -64,7 +66,7 @@ describe Checkdin::UserBridge, '#login_url' do
     end
 
     context "with an optional action set" do
-      let(:authentication_action) { 'authenticate_facebook' }
+      let(:options) { default_options.merge(:authentication_action => 'authenticate_facebook') }
 
       it "includes the authentication_action" do
         Timecop.freeze(Time.at(timestamp)) do
@@ -72,6 +74,16 @@ describe Checkdin::UserBridge, '#login_url' do
         end
       end
     end
+
+    context "with additional attributes set" do
+      let(:options) { default_options.merge(:delivery_email => false) }
+
+      it "includes the additional attriubtes" do
+        Timecop.freeze(Time.at(timestamp)) do
+          subject.should == "https://app.checkd.in/user_landing?auth_timestamp=1325605589&client_id=client-1704&client_uid=17-batch1-bob&delivery_email=false&digest=f3950bee05fb1ca97727d9c190f2b30cfbdcf74a7150b3c337afbfc557d988dc&email=bob%40example.com"
+        end
+      end
+    end
   end
 
   context "custom subdomain" do
@@ -95,7 +107,8 @@ end
 
 describe Checkdin::UserBridge, '#build_authenticated_parameters' do
   let(:instance) { Checkdin::UserBridge.new(:client_identifier => client_identifier, :bridge_secret => bridge_secret) }
-  subject { instance.build_authenticated_parameters(user_email, user_identifier) }
+  subject { instance.build_authenticated_parameters(user_email, user_identifier, options) }
+  let(:options) { {} }
   let(:client_identifier) { 'client-1704' }
   let(:bridge_secret) { '123-shared-secret' }
   let(:user_email) { 'bob@example.com' }
@@ -114,15 +127,15 @@ describe Checkdin::UserBridge, '#build_authenticated_parameters' do
     end
   end
 
-  context "with an authenticated action" do
-    subject { instance.build_authenticated_parameters(user_email, user_identifier, authentication_action) }
-    let(:authentication_action) { 'authenticate_facebook' }
+  context "with an authenticated action in the options" do
+    subject { instance.build_authenticated_parameters(user_email, user_identifier, options) }
+    let(:options) { {:authentication_action => 'authenticate_facebook'} }
 
     it "should output a hash with a different digest and the authenticated_action included" do
       Timecop.freeze(Time.at(timestamp)) do
         subject.should == {
           'auth_timestamp'        => timestamp,
-          'authentication_action' => authentication_action,
+          'authentication_action' => 'authenticate_facebook',
           'client_id'             => client_identifier,
           'client_uid'            => user_identifier,
           'email'                 => user_email,

data/spec/fixtures/vcr_cassettes/Checkdin_Leaderboard/viewing_a_leaderboard_for_a_campaign_s_classifications.yml

@@ -0,0 +1,46 @@
+--- 
+- !ruby/struct:VCR::HTTPInteraction 
+  request: !ruby/struct:VCR::Request 
+    method: :get
+    uri: https://staging:cKGdyvb4gQD9YJg3cACV@staging.checkd.in:443/api/v1/campaigns/35/classification_leaderboard?client_id={client_id}&client_secret={client_secret}
+    body: 
+    headers: 
+      accept: 
+      - application/json
+      user-agent: 
+      - checkdin ruby gem 0.2.7
+      accept-encoding: 
+      - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
+  response: !ruby/struct:VCR::Response 
+    status: !ruby/struct:VCR::ResponseStatus 
+      code: 200
+      message: OK
+    headers: 
+      server: 
+      - nginx/1.0.11
+      date: 
+      - Thu, 16 Aug 2012 14:06:50 GMT
+      content-type: 
+      - application/json; charset=utf-8
+      transfer-encoding: 
+      - chunked
+      connection: 
+      - keep-alive
+      status: 
+      - 200 OK
+      strict-transport-security: 
+      - max-age=31536000
+      x-ua-compatible: 
+      - IE=Edge,chrome=1
+      etag: 
+      - "\"0016a5775b88d5dbd81551ebc2148c1b\""
+      cache-control: 
+      - must-revalidate, private, max-age=0
+      x-request-id: 
+      - 707edb8903bd34be9db20d17dc393e6d
+      x-runtime: 
+      - "0.159060"
+      x-rack-cache: 
+      - miss
+    body: "{\"classifications\":[{\"classification\":\"grouped\",\"total_points\":10,\"members\":1}]}"
+    http_version: "1.1"

metadata

@@ -2,7 +2,7 @@
 name: checkdin
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 0.2.7
+  version: 0.2.8
 platform: ruby
 authors: 
 - Matt Mueller
@@ -183,6 +183,7 @@ files:
 - spec/fixtures/vcr_cassettes/Checkdin_Campaigns/viewing_a_single_campaign.yml
 - spec/fixtures/vcr_cassettes/Checkdin_CustomActivities.yml
 - spec/fixtures/vcr_cassettes/Checkdin_Leaderboard/viewing_a_leaderboard_for_a_campaign.yml
+- spec/fixtures/vcr_cassettes/Checkdin_Leaderboard/viewing_a_leaderboard_for_a_campaign_s_classifications.yml
 - spec/fixtures/vcr_cassettes/Checkdin_Promotions/viewing_a_list_of_promotions.yml
 - spec/fixtures/vcr_cassettes/Checkdin_Promotions/viewing_a_single_promotion.yml
 - spec/fixtures/vcr_cassettes/Checkdin_Promotions/viewing_the_votes_leaderboard_for_a_promotion.yml