checkdin 0.2.4 → 0.2.5

data/lib/checkdin.rb

@@ -3,6 +3,7 @@ require 'faraday_middleware'
 
 require 'openssl'
 require 'active_support/core_ext/object/to_query'
+require 'active_support/core_ext/object/blank'
 
 require 'checkdin/version'
 require 'checkdin/leaderboard'

data/lib/checkdin/api_error.rb

@@ -1,14 +1,15 @@
 module Checkdin
   class APIError < StandardError
 
-    attr_reader :status
+    attr_reader :status, :body
 
-    def initialize(status)
+    def initialize(status, body)
       @status   = status
+      @body     = body
     end
 
     def message
-      "Status Code: #{@status}"
+      "Status Code: #{status}\nBody: #{body}"
     end
   end
-end
+end

data/lib/checkdin/client.rb

@@ -14,6 +14,11 @@ module Checkdin
     include Votes
 
     attr_reader :client_id, :client_secret
+    attr_reader :ssl
+    # Base URL for api requests.
+    attr_reader :api_url
+
+    DEFAULT_API_URL = "https://app.checkd.in/api/v1"
 
     #Initialize the client class that will be used for all checkd.in API requests.  Requires a valid client_id and client_secret - more info at http://developer.checkd.in
     #
@@ -21,54 +26,50 @@ module Checkdin
     # @param [Hash] options
     # @option options String :client_id Your foursquare app's client_id
     # @option options String :client_secret Your foursquare app's client_secret
+    # @option options String :api_url A custom API url, does not usually have to be overridden
     # @option options Hash   :ssl Additional SSL options (like the path to certificate file)
-    
+
     def initialize(options={})
-      @client_id = options[:client_id]
-      @client_secret = options[:client_secret]
-      @ssl = options[:ssl].nil? ? Hash.new : options[:ssl]
-    end
-    
-    def ssl
-      @ssl
+      @client_id     = options.delete(:client_id)
+      @client_secret = options.delete(:client_secret)
+      @api_url       = options.delete(:api_url) || DEFAULT_API_URL
+      @ssl           = options.delete(:ssl) || {}
+
+      raise ArgumentError.new("Unexpected argument given: #{options.inspect}") unless options.blank?
     end
-    
-    # Sets up the connection to be used for all requests based on options passed during initialization.
 
+    # Sets up the connection to be used for all requests based on options passed during initialization.
     def connection
-      params = {}
-      params[:client_id] = @client_id
-      params[:client_secret] = @client_secret
-      @connection ||= Faraday::Connection.new(:url => api_url, :ssl => @ssl, :params => params, :headers => default_headers) do |builder|
-        builder.use Faraday::Request::Multipart
-        builder.use Faraday::Request::UrlEncoded
+      @connection ||= begin
+        params = {
+          :client_id     => client_id,
+          :client_secret => client_secret
+        }
 
-        builder.use FaradayMiddleware::Mashify
-        builder.use FaradayMiddleware::ParseJson
+        Faraday::Connection.new(:url => api_url, :ssl => ssl, :params => params, :headers => default_headers) do |builder|
+          builder.use Faraday::Request::Multipart
+          builder.use Faraday::Request::UrlEncoded
 
-        builder.adapter Faraday.default_adapter
+          builder.use FaradayMiddleware::Mashify
+          builder.use FaradayMiddleware::ParseJson
 
+          builder.adapter Faraday.default_adapter
+        end
       end
     end
 
-    # Base URL for api requests.
-
-    def api_url
-      "https://app.checkd.in/api/v1"
-    end
-
     # Helper method to return errors or desired response data as appropriate.
     #
     # Added just for convenience to avoid having to traverse farther down the response just to get to returned data.
 
     def return_error_or_body(response)
-      if response.status == 200 
+      if response.status == 200
         response.body
       else
-        raise Checkdin::APIError.new(response.status)
+        raise Checkdin::APIError.new(response.status, response.body)
       end
     end
-      
+
     private
 
 
@@ -80,4 +81,4 @@ module Checkdin
     end
 
   end
-end
+end

data/lib/checkdin/version.rb

@@ -1,3 +1,3 @@
 module Checkdin
-  VERSION = '0.2.4'
+  VERSION = '0.2.5'
 end

data/spec/checkdin/activities_spec.rb

@@ -3,7 +3,7 @@ require 'spec_helper'
 describe Checkdin::Activities do
 
   before do
-    @client = Checkdin::Client.new(:client_id => '123456', :client_secret => '7890')
+    @client = Checkdin::Client.new(TestCredentials.client_args)
   end
 
   context "viewing a single activity" do
@@ -69,4 +69,4 @@ describe Checkdin::Activities do
       end
     end
   end
-end
+end

data/spec/checkdin/campaigns_spec.rb

@@ -3,7 +3,7 @@ require 'spec_helper'
 describe Checkdin::Campaigns do
 
   before do
-    @client = Checkdin::Client.new(:client_id => '123456', :client_secret => '7890')
+    @client = Checkdin::Client.new(TestCredentials.client_args)
   end
 
   context "viewing a single campaign" do
@@ -29,4 +29,4 @@ describe Checkdin::Campaigns do
       result.first.campaign.name.should == "Check In To Win!"
     end
   end
-end
+end

data/spec/checkdin/client_spec.rb

@@ -14,5 +14,16 @@ describe Checkdin::Client do
     it "has the version available" do
       Checkdin::VERSION.should =~ /^\d\.\d\.\d/
     end
+
+    it "takes an optional api_url" do
+      instance = Checkdin::Client.new(:api_url => 'https://bogus.checkd.in/api/v7')
+      instance.api_url.should == 'https://bogus.checkd.in/api/v7'
+    end
+
+    it "raises an error when an unknown option is passed" do
+      expect {
+        Checkdin::Client.new(:unexpected_present => 'details here')
+      }.to raise_error(ArgumentError, /unexpected_present/)
+    end
   end
-end
+end

data/spec/checkdin/custom_activities_spec.rb

@@ -4,7 +4,7 @@ describe Checkdin::CustomActivities do
   use_vcr_cassette
 
   before do
-    @client = Checkdin::Client.new(:client_id => '123456', :client_secret => '7890')
+    @client = Checkdin::Client.new(TestCredentials.client_args)
   end
 
   it "should report success when creating a custom activity" do

data/spec/checkdin/leaderboard_spec.rb

@@ -3,7 +3,7 @@ require 'spec_helper'
 describe Checkdin::Leaderboard do
 
   before do
-    @client = Checkdin::Client.new(:client_id => '123456', :client_secret => '7890')
+    @client = Checkdin::Client.new(TestCredentials.client_args)
   end
 
   context "viewing a leaderboard for a campaign" do
@@ -15,4 +15,4 @@ describe Checkdin::Leaderboard do
       result.leaders.count.should == 5
     end
   end
-end
+end

data/spec/checkdin/promotions_spec.rb

@@ -3,7 +3,7 @@ require 'spec_helper'
 describe Checkdin::Promotions do
 
   before do
-    @client = Checkdin::Client.new(:client_id => '123456', :client_secret => '7890')
+    @client = Checkdin::Client.new(TestCredentials.client_args)
   end
 
   context "viewing a single promotion" do
@@ -60,4 +60,4 @@ describe Checkdin::Promotions do
       end
     end
   end
-end
+end

data/spec/checkdin/users_spec.rb

@@ -3,7 +3,7 @@ require 'spec_helper'
 describe Checkdin::Users do
 
   before do
-    @client = Checkdin::Client.new(:client_id => '123456', :client_secret => '7890')
+    @client = Checkdin::Client.new(TestCredentials.client_args)
   end
 
   context "viewing a single user" do
@@ -55,4 +55,4 @@ describe Checkdin::Users do
       end
     end
   end
-end
+end

data/spec/checkdin/won_rewards_spec.rb

@@ -3,7 +3,7 @@ require 'spec_helper'
 describe Checkdin::WonRewards do
 
   before do
-    @client = Checkdin::Client.new(:client_id => '123456', :client_secret => '7890')
+    @client = Checkdin::Client.new(TestCredentials.client_args)
   end
 
   context "viewing a single won reward" do
@@ -42,4 +42,4 @@ describe Checkdin::WonRewards do
     end
 
   end
-end
+end

data/spec/fixtures/vcr_cassettes/Checkdin_Activities/viewing_a_list_of_activities.yml

@@ -2,8 +2,8 @@
 - !ruby/struct:VCR::HTTPInteraction
   request: !ruby/struct:VCR::Request
     method: :get
-    uri: https://app.checkd.in:443/api/v1/activities?client_id=123456&client_secret=7890&limit=2
-    body: !!null 
+    uri: https://app.checkd.in:443/api/v1/activities?client_id={client_id}&client_secret={client_secret}&limit=2
+    body: !!null
     headers:
       accept:
       - application/json

data/spec/fixtures/vcr_cassettes/Checkdin_Activities/viewing_a_single_activity.yml

@@ -2,8 +2,8 @@
 - !ruby/struct:VCR::HTTPInteraction
   request: !ruby/struct:VCR::Request
     method: :get
-    uri: https://app.checkd.in:443/api/v1/activities/236?client_id=123456&client_secret=7890
-    body: !!null 
+    uri: https://app.checkd.in:443/api/v1/activities/236?client_id={client_id}&client_secret={client_secret}
+    body: !!null
     headers:
       accept:
       - application/json

data/spec/fixtures/vcr_cassettes/Checkdin_Activities/voting_for_an_activity.yml

@@ -1,46 +1,46 @@
---- 
-- !ruby/struct:VCR::HTTPInteraction 
-  request: !ruby/struct:VCR::Request 
+---
+- !ruby/struct:VCR::HTTPInteraction
+  request: !ruby/struct:VCR::Request
     method: :post
-    uri: https://app.checkd.in:443/api/v1/activities/18881/vote?client_id=123456&client_secret=7890
-    body: 
-    headers: 
-      accept: 
+    uri: https://app.checkd.in:443/api/v1/activities/18881/vote?client_id={client_id}&client_secret={client_secret}
+    body:
+    headers:
+      accept:
       - application/json
-      user-agent: 
+      user-agent:
       - checkdin ruby gem 0.2.1
-      content-length: 
+      content-length:
       - "0"
-  response: !ruby/struct:VCR::Response 
-    status: !ruby/struct:VCR::ResponseStatus 
+  response: !ruby/struct:VCR::Response
+    status: !ruby/struct:VCR::ResponseStatus
       code: 200
       message: OK
-    headers: 
-      server: 
+    headers:
+      server:
       - nginx/1.0.11
-      date: 
+      date:
       - Mon, 09 Apr 2012 10:38:50 GMT
-      content-type: 
+      content-type:
       - application/json; charset=utf-8
-      transfer-encoding: 
+      transfer-encoding:
       - chunked
-      connection: 
+      connection:
       - keep-alive
-      status: 
+      status:
       - 200 OK
-      strict-transport-security: 
+      strict-transport-security:
       - max-age=31536000
-      x-ua-compatible: 
+      x-ua-compatible:
       - IE=Edge,chrome=1
-      etag: 
+      etag:
       - "\"78c7474e01ca50b8cfc238ad7974fed1\""
-      cache-control: 
+      cache-control:
       - max-age=0, private, must-revalidate
-      set-cookie: 
+      set-cookie:
       - _checkdin_session=BAh7BkkiD3Nlc3Npb25faWQGOgZFRkkiJWQ3MmVkYzllYzNhZWVhYmU4ZmQ2YjNlN2IxZjEyMjE2BjsAVA%3D%3D--8c08feb9944b93e628e7740a373d79e5adb6bd73; domain=app.checkd.in; path=/; HttpOnly; secure
-      x-runtime: 
+      x-runtime:
       - "0.039170"
-      x-rack-cache: 
+      x-rack-cache:
       - invalidate, pass
     body: |
       {"activity":{"type":"twitter_status","id":18881,"created_at":"2012-02-21T16:08:55-06:00","acted_on":{"type":"twitter_status","tweet_fk":172080368760000512,"status":"Check out what I purchased at #mynordstrom http://t.co/DKUXa41E","photo_url":"https://p.twimg.com/AmNaLwUCEAIt1v3.jpg","photo_thumbnail_url":"https://p.twimg.com/AmNaLwUCEAIt1v3.jpg:thumb"},"user":{"id":36,"username":"demomattloadtest","avatar_url":null,"href":"https://app.checkd.in/api/v1/activities.json?user_id=36"},"vote_count":6}}

data/spec/fixtures/vcr_cassettes/Checkdin_Activities/voting_for_an_activity/passing_an_email.yml

@@ -1,46 +1,46 @@
---- 
-- !ruby/struct:VCR::HTTPInteraction 
-  request: !ruby/struct:VCR::Request 
+---
+- !ruby/struct:VCR::HTTPInteraction
+  request: !ruby/struct:VCR::Request
     method: :post
-    uri: https://app.checkd.in:443/api/v1/activities/18881/vote?client_id=123456&client_secret=7890&user_id=36
-    body: 
-    headers: 
-      accept: 
+    uri: https://app.checkd.in:443/api/v1/activities/18881/vote?client_id={client_id}&client_secret={client_secret}&user_id=36
+    body:
+    headers:
+      accept:
       - application/json
-      user-agent: 
+      user-agent:
       - checkdin ruby gem 0.2.1
-      content-length: 
+      content-length:
       - "0"
-  response: !ruby/struct:VCR::Response 
-    status: !ruby/struct:VCR::ResponseStatus 
+  response: !ruby/struct:VCR::Response
+    status: !ruby/struct:VCR::ResponseStatus
       code: 200
       message: OK
-    headers: 
-      server: 
+    headers:
+      server:
       - nginx/1.0.11
-      date: 
+      date:
       - Mon, 09 Apr 2012 10:42:37 GMT
-      content-type: 
+      content-type:
       - application/json; charset=utf-8
-      transfer-encoding: 
+      transfer-encoding:
       - chunked
-      connection: 
+      connection:
       - keep-alive
-      status: 
+      status:
       - 200 OK
-      strict-transport-security: 
+      strict-transport-security:
       - max-age=31536000
-      x-ua-compatible: 
+      x-ua-compatible:
       - IE=Edge,chrome=1
-      etag: 
+      etag:
       - "\"22ee544aa801964a479d745eb9bdba07\""
-      cache-control: 
+      cache-control:
       - max-age=0, private, must-revalidate
-      set-cookie: 
+      set-cookie:
       - _checkdin_session=BAh7BkkiD3Nlc3Npb25faWQGOgZFRkkiJTYyNjY0NTlhMThkZmFjNTJlMzcwMTA4NTc0OThiMWZlBjsAVA%3D%3D--c70adeb132862f669fc85fc8e5e643ea2b811b57; domain=app.checkd.in; path=/; HttpOnly; secure
-      x-runtime: 
-      - "0.037890"
-      x-rack-cache: 
+      x-runtime:
+      - "0.03{client_secret}"
+      x-rack-cache:
       - invalidate, pass
     body: |
       {"activity":{"type":"twitter_status","id":18881,"created_at":"2012-02-21T16:08:55-06:00","acted_on":{"type":"twitter_status","tweet_fk":172080368760000512,"status":"Check out what I purchased at #mynordstrom http://t.co/DKUXa41E","photo_url":"https://p.twimg.com/AmNaLwUCEAIt1v3.jpg","photo_thumbnail_url":"https://p.twimg.com/AmNaLwUCEAIt1v3.jpg:thumb"},"user":{"id":36,"username":"demomattloadtest","avatar_url":null,"href":"https://app.checkd.in/api/v1/activities.json?user_id=36"},"vote_count":7}}

data/spec/fixtures/vcr_cassettes/Checkdin_Campaigns/viewing_a_list_of_campaigns.yml

@@ -2,8 +2,8 @@
 - !ruby/struct:VCR::HTTPInteraction
   request: !ruby/struct:VCR::Request
     method: :get
-    uri: https://app.checkd.in:443/api/v1/campaigns?client_id=123456&client_secret=7890
-    body: !!null 
+    uri: https://app.checkd.in:443/api/v1/campaigns?client_id={client_id}&client_secret={client_secret}
+    body: !!null
     headers:
       accept:
       - application/json

data/spec/fixtures/vcr_cassettes/Checkdin_Campaigns/viewing_a_single_campaign.yml

@@ -2,8 +2,8 @@
 - !ruby/struct:VCR::HTTPInteraction
   request: !ruby/struct:VCR::Request
     method: :get
-    uri: https://app.checkd.in:443/api/v1/campaigns/2?client_id=123456&client_secret=7890
-    body: !!null 
+    uri: https://app.checkd.in:443/api/v1/campaigns/2?client_id={client_id}&client_secret={client_secret}
+    body: !!null
     headers:
       accept:
       - application/json
@@ -45,7 +45,7 @@
       coffee!  Enjoy!","terms":"Offer only good at some locations.","above_21_only":false,"ends_at":"2012-10-16T07:51:32-05:00","href":"https://app.checkd.in/api/v1/promotions/8.json","type":"promotion_lbs_checkin","place_groups":[{"place_group":{"name":"Stores","href":"https://app.checkd.in/api/v1/place_groups/2.json"}}],"reward":{"private_delivery_description":"Thank
       you for checking-in five times! Because you
       are such a loyal customer, we would like to treat you to a free medium coffee!
-      ","public_delivery_description":"Free coffee 
+      ","public_delivery_description":"Free coffee
       for every 5 visits - check it out - http://something.com","single_delivery":false,"type":"badge_reward","reward_file":"5thCheckinBarcode.png"},"trigger_schedule":{"rewarding":"once","winner_picked":"activity_interval","interval":5,"human_readable":"Rewarded
       once when a user reaches 5 relevant actions or points."}}}]}}'
     http_version: '1.1'

data/spec/fixtures/vcr_cassettes/Checkdin_CustomActivities.yml

@@ -2,8 +2,8 @@
 - !ruby/struct:VCR::HTTPInteraction
   request: !ruby/struct:VCR::Request
     method: :post
-    uri: https://app.checkd.in:443/api/v1/custom_activities?client_id=123456&client_secret=7890&custom_activity_node_id=1&email=muellermr@gmail.com
-    body: !!null 
+    uri: https://app.checkd.in:443/api/v1/custom_activities?client_id={client_id}&client_secret={client_secret}&custom_activity_node_id=1&email=muellermr@gmail.com
+    body: !!null
     headers:
       accept:
       - application/json

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

@@ -2,8 +2,8 @@
 - !ruby/struct:VCR::HTTPInteraction
   request: !ruby/struct:VCR::Request
     method: :get
-    uri: https://app.checkd.in:443/api/v1/campaigns/2/leaderboard?client_id=123456&client_secret=7890&limit=5
-    body: !!null 
+    uri: https://app.checkd.in:443/api/v1/campaigns/2/leaderboard?client_id={client_id}&client_secret={client_secret}&limit=5
+    body: !!null
     headers:
       accept:
       - application/json

data/spec/fixtures/vcr_cassettes/Checkdin_Promotions/viewing_a_list_of_promotions.yml

@@ -2,8 +2,8 @@
 - !ruby/struct:VCR::HTTPInteraction
   request: !ruby/struct:VCR::Request
     method: :get
-    uri: https://app.checkd.in:443/api/v1/promotions?client_id=123456&client_secret=7890&limit=2
-    body: !!null 
+    uri: https://app.checkd.in:443/api/v1/promotions?client_id={client_id}&client_secret={client_secret}&limit=2
+    body: !!null
     headers:
       accept:
       - application/json
@@ -42,7 +42,7 @@
       for every 5 check ins!","description":"Every 5 times you check in at our new
       location you will be rewarded with a free coffee!  Enjoy!","terms":"Offer
       only good redeem same or next business day.","above_21_only":false,"ends_at":"2012-10-16T07:51:32-05:00","href":"https://app.checkd.in/api/v1/promotions/8.json","type":"promotion_lbs_checkin","place_groups":[{"place_group":{"name":"Stores","href":"https://app.checkd.in/api/v1/place_groups/2.json"}}],"reward":{"private_delivery_description":"Thank
-      you for checking-in five times","public_delivery_description":"Free coffee 
+      you for checking-in five times","public_delivery_description":"Free coffee
       for every 5 visits - check it out - http://something.com","single_delivery":false,"type":"badge_reward","reward_file":"5thCheckinBarcode.png"},"trigger_schedule":{"rewarding":"once","winner_picked":"activity_interval","interval":5,"human_readable":"Rewarded
       once when a user reaches 5 relevant actions or points."},"campaign":{"name":"Check
       In To Win","description":"Check in to win free coffee and

data/spec/fixtures/vcr_cassettes/Checkdin_Promotions/viewing_a_single_promotion.yml

@@ -2,8 +2,8 @@
 - !ruby/struct:VCR::HTTPInteraction
   request: !ruby/struct:VCR::Request
     method: :get
-    uri: https://app.checkd.in:443/api/v1/promotions/8?client_id=123456&client_secret=7890
-    body: !!null 
+    uri: https://app.checkd.in:443/api/v1/promotions/8?client_id={client_id}&client_secret={client_secret}
+    body: !!null
     headers:
       accept:
       - application/json
@@ -43,7 +43,7 @@
       rewarded with a free coffee!  Enjoy!","terms":"Offer only good some places.","above_21_only":false,"ends_at":"2012-10-16T07:51:32-05:00","href":"https://app.checkd.in/api/v1/promotions/8.json","type":"promotion_lbs_checkin","place_groups":[{"place_group":{"name":"Stores","href":"https://app.checkd.in/api/v1/place_groups/2.json"}}],"reward":{"private_delivery_description":"Thank
       you for checking-in five times! Because you
       are such a loyal customer, we would like to treat you to a free medium coffee!
-      ","public_delivery_description":"Free coffee 
+      ","public_delivery_description":"Free coffee
       for every 5 visits - check it out - http://something.com","single_delivery":false,"type":"badge_reward","reward_file":"DD-5thCheckinBarcode.png"},"trigger_schedule":{"rewarding":"once","winner_picked":"activity_interval","interval":5,"human_readable":"Rewarded
       once when a user reaches 5 relevant actions or points."},"campaign":{"name":"Check
       In To Win","description":"Check in to win free coffee and

data/spec/fixtures/vcr_cassettes/Checkdin_Promotions/viewing_the_votes_leaderboard_for_a_promotion.yml

@@ -1,44 +1,44 @@
---- 
-- !ruby/struct:VCR::HTTPInteraction 
-  request: !ruby/struct:VCR::Request 
+---
+- !ruby/struct:VCR::HTTPInteraction
+  request: !ruby/struct:VCR::Request
     method: :get
-    uri: https://app.checkd.in:443/api/v1/promotions/54/votes_leaderboard?client_id=123456&client_secret=7890&limit
-    body: 
-    headers: 
-      accept: 
+    uri: https://app.checkd.in:443/api/v1/promotions/54/votes_leaderboard?client_id={client_id}&client_secret={client_secret}&limit
+    body:
+    headers:
+      accept:
       - application/json
-      user-agent: 
+      user-agent:
       - checkdin ruby gem 0.2.1
-      accept-encoding: 
+      accept-encoding:
       - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
-  response: !ruby/struct:VCR::Response 
-    status: !ruby/struct:VCR::ResponseStatus 
+  response: !ruby/struct:VCR::Response
+    status: !ruby/struct:VCR::ResponseStatus
       code: 200
       message: OK
-    headers: 
-      server: 
+    headers:
+      server:
       - nginx/1.0.11
-      date: 
+      date:
       - Mon, 09 Apr 2012 11:00:42 GMT
-      content-type: 
+      content-type:
       - application/json; charset=utf-8
-      transfer-encoding: 
+      transfer-encoding:
       - chunked
-      connection: 
+      connection:
       - keep-alive
-      status: 
+      status:
       - 200 OK
-      strict-transport-security: 
+      strict-transport-security:
       - max-age=31536000
-      x-ua-compatible: 
+      x-ua-compatible:
       - IE=Edge,chrome=1
-      etag: 
+      etag:
       - "\"5e76880528d8f34bcf0b8faae48936d6\""
-      cache-control: 
+      cache-control:
       - must-revalidate, private, max-age=0
-      x-runtime: 
+      x-runtime:
       - "0.123999"
-      x-rack-cache: 
+      x-rack-cache:
       - miss
     body: "{\"promotion\":{\"title\":\"A voting promotion!\",\"description\":\"You iz winning.\",\"terms\":\"\",\"above_21_only\":false,\"ends_at\":\"2012-05-08T05:42:00-05:00\",\"href\":\"https://app.checkd.in/api/v1/promotions/54.json\",\"type\":\"promotion_photo\",\"twitter_hashtag\":\"#mynordstrom\",\"participant_status_message\":null,\"reward\":{\"private_delivery_description\":\"You won\",\"public_delivery_description\":\"\",\"single_delivery\":false,\"type\":\"point_reward\",\"reward_points\":100},\"trigger_schedule\":{\"rewarding\":\"many\",\"winner_picked\":\"activity_interval\",\"interval\":1,\"human_readable\":\"Rewarded every time the same user performs a relevant action.\"},\"votes_leaderboard\":{\"total_pages\":1,\"activities\":[{\"activity\":{\"type\":\"twitter_status\",\"id\":18881,\"created_at\":\"2012-02-21T16:08:55-06:00\",\"acted_on\":{\"type\":\"twitter_status\",\"tweet_fk\":172080368760000512,\"status\":\"Check out what I purchased at #mynordstrom http://t.co/DKUXa41E\",\"photo_url\":\"https://p.twimg.com/AmNaLwUCEAIt1v3.jpg\",\"photo_thumbnail_url\":\"https://p.twimg.com/AmNaLwUCEAIt1v3.jpg:thumb\"},\"user\":{\"id\":36,\"username\":\"demomattloadtest\",\"avatar_url\":null,\"href\":\"https://app.checkd.in/api/v1/activities.json?user_id=36\"},\"href\":\"https://app.checkd.in/api/v1/activities/18881.json\",\"vote_count\":7}},{\"activity\":{\"type\":\"twitter_status\",\"id\":18882,\"created_at\":\"2012-02-22T09:08:47-06:00\",\"acted_on\":{\"type\":\"twitter_status\",\"tweet_fk\":172337035716198401,\"status\":\"Check out #mynordstrom http://t.co/bvqmQX7B\",\"photo_url\":\"https://p.twimg.com/AmRDnvPCAAIYYMY.jpg\",\"photo_thumbnail_url\":\"https://p.twimg.com/AmRDnvPCAAIYYMY.jpg:thumb\"},\"user\":{\"id\":36,\"username\":\"demomattloadtest\",\"avatar_url\":null,\"href\":\"https://app.checkd.in/api/v1/activities.json?user_id=36\"},\"href\":\"https://app.checkd.in/api/v1/activities/18882.json\",\"vote_count\":0}},{\"activity\":{\"type\":\"twitter_status\",\"id\":18883,\"created_at\":\"2012-02-22T09:55:58-06:00\",\"acted_on\":{\"type\":\"twitter_status\",\"tweet_fk\":172348911032336384,\"status\":\"Check out this cool purchase #mynordstrom http://t.co/JKXzWuVu\",\"photo_url\":\"https://p.twimg.com/AmROa-PCAAAcMe1.jpg\",\"photo_thumbnail_url\":\"https://p.twimg.com/AmROa-PCAAAcMe1.jpg:thumb\"},\"user\":{\"id\":36,\"username\":\"demomattloadtest\",\"avatar_url\":null,\"href\":\"https://app.checkd.in/api/v1/activities.json?user_id=36\"},\"href\":\"https://app.checkd.in/api/v1/activities/18883.json\",\"vote_count\":0}}]},\"campaign\":{\"name\":\"Nordstrom Rewards\",\"description\":\"Earn discounts and other great rewards for joining Nordstrom Fashion Rewards!\",\"start_date\":\"2011-12-14\",\"end_date\":\"2012-06-01\",\"href\":\"https://app.checkd.in/api/v1/campaigns/11.json\"}}}"
     http_version: "1.1"

data/spec/fixtures/vcr_cassettes/Checkdin_Promotions/viewing_the_votes_leaderboard_for_a_promotion/limiting_the_number_of_records_returned.yml

@@ -1,44 +1,44 @@
---- 
-- !ruby/struct:VCR::HTTPInteraction 
-  request: !ruby/struct:VCR::Request 
+---
+- !ruby/struct:VCR::HTTPInteraction
+  request: !ruby/struct:VCR::Request
     method: :get
-    uri: https://app.checkd.in:443/api/v1/promotions/54/votes_leaderboard?client_id=123456&client_secret=7890&limit=1
-    body: 
-    headers: 
-      accept: 
+    uri: https://app.checkd.in:443/api/v1/promotions/54/votes_leaderboard?client_id={client_id}&client_secret={client_secret}&limit=1
+    body:
+    headers:
+      accept:
       - application/json
-      user-agent: 
+      user-agent:
       - checkdin ruby gem 0.2.1
-      accept-encoding: 
+      accept-encoding:
       - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
-  response: !ruby/struct:VCR::Response 
-    status: !ruby/struct:VCR::ResponseStatus 
+  response: !ruby/struct:VCR::Response
+    status: !ruby/struct:VCR::ResponseStatus
       code: 200
       message: OK
-    headers: 
-      server: 
+    headers:
+      server:
       - nginx/1.0.11
-      date: 
+      date:
       - Mon, 09 Apr 2012 11:02:11 GMT
-      content-type: 
+      content-type:
       - application/json; charset=utf-8
-      transfer-encoding: 
+      transfer-encoding:
       - chunked
-      connection: 
+      connection:
       - keep-alive
-      status: 
+      status:
       - 200 OK
-      strict-transport-security: 
+      strict-transport-security:
       - max-age=31536000
-      x-ua-compatible: 
+      x-ua-compatible:
       - IE=Edge,chrome=1
-      etag: 
+      etag:
       - "\"616689e5a2d0af0ef532965e0f6aad51\""
-      cache-control: 
+      cache-control:
       - must-revalidate, private, max-age=0
-      x-runtime: 
+      x-runtime:
       - "0.128383"
-      x-rack-cache: 
+      x-rack-cache:
       - miss
     body: "{\"promotion\":{\"title\":\"A voting promotion!\",\"description\":\"You iz winning\",\"terms\":\"\",\"above_21_only\":false,\"ends_at\":\"2012-05-08T05:42:00-05:00\",\"href\":\"https://app.checkd.in/api/v1/promotions/54.json\",\"type\":\"promotion_photo\",\"twitter_hashtag\":\"#mynordstrom\",\"participant_status_message\":null,\"reward\":{\"private_delivery_description\":\"\",\"public_delivery_description\":\"\",\"single_delivery\":false,\"type\":\"point_reward\",\"reward_points\":100},\"trigger_schedule\":{\"rewarding\":\"many\",\"winner_picked\":\"activity_interval\",\"interval\":1,\"human_readable\":\"Rewarded every time the same user performs a relevant action.\"},\"votes_leaderboard\":{\"total_pages\":3,\"activities\":[{\"activity\":{\"type\":\"twitter_status\",\"id\":18881,\"created_at\":\"2012-02-21T16:08:55-06:00\",\"acted_on\":{\"type\":\"twitter_status\",\"tweet_fk\":172080368760000512,\"status\":\"Check out what I purchased at #mynordstrom http://t.co/DKUXa41E\",\"photo_url\":\"https://p.twimg.com/AmNaLwUCEAIt1v3.jpg\",\"photo_thumbnail_url\":\"https://p.twimg.com/AmNaLwUCEAIt1v3.jpg:thumb\"},\"user\":{\"id\":36,\"username\":\"demomattloadtest\",\"avatar_url\":null,\"href\":\"https://app.checkd.in/api/v1/activities.json?user_id=36\"},\"href\":\"https://app.checkd.in/api/v1/activities/18881.json\",\"vote_count\":7}}]},\"campaign\":{\"name\":\"Nordstrom Rewards\",\"description\":\"Earn discounts and other great rewards for joining Nordstrom Fashion Rewards!\",\"start_date\":\"2011-12-14\",\"end_date\":\"2012-06-01\",\"href\":\"https://app.checkd.in/api/v1/campaigns/11.json\"}}}"
     http_version: "1.1"

data/spec/fixtures/vcr_cassettes/Checkdin_Users/viewing_a_list_of_users.yml

@@ -2,8 +2,8 @@
 - !ruby/struct:VCR::HTTPInteraction
   request: !ruby/struct:VCR::Request
     method: :get
-    uri: https://app.checkd.in:443/api/v1/users?client_id=123456&client_secret=7890&limit=2
-    body: !!null 
+    uri: https://app.checkd.in:443/api/v1/users?client_id={client_id}&client_secret={client_secret}&limit=2
+    body: !!null
     headers:
       accept:
       - application/json

data/spec/fixtures/vcr_cassettes/Checkdin_Users/viewing_a_single_user.yml

@@ -2,8 +2,8 @@
 - !ruby/struct:VCR::HTTPInteraction
   request: !ruby/struct:VCR::Request
     method: :get
-    uri: https://app.checkd.in:443/api/v1/users/187?client_id=123456&client_secret=7890
-    body: !!null 
+    uri: https://app.checkd.in:443/api/v1/users/187?client_id={client_id}&client_secret={client_secret}
+    body: !!null
     headers:
       accept:
       - application/json

data/spec/fixtures/vcr_cassettes/Checkdin_Votes/filtering_by_a_single_user.yml

@@ -1,44 +1,44 @@
---- 
-- !ruby/struct:VCR::HTTPInteraction 
-  request: !ruby/struct:VCR::Request 
+---
+- !ruby/struct:VCR::HTTPInteraction
+  request: !ruby/struct:VCR::Request
     method: :get
-    uri: https://app.checkd.in:443/api/v1/votes?client_id=123456&client_secret=7890&user_id=36
-    body: 
-    headers: 
-      accept: 
+    uri: https://app.checkd.in:443/api/v1/votes?client_id={client_id}&client_secret={client_secret}&user_id=36
+    body:
+    headers:
+      accept:
       - application/json
-      user-agent: 
+      user-agent:
       - checkdin ruby gem 0.2.2
-      accept-encoding: 
+      accept-encoding:
       - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
-  response: !ruby/struct:VCR::Response 
-    status: !ruby/struct:VCR::ResponseStatus 
+  response: !ruby/struct:VCR::Response
+    status: !ruby/struct:VCR::ResponseStatus
       code: 200
       message: OK
-    headers: 
-      server: 
+    headers:
+      server:
       - nginx/1.0.11
-      date: 
+      date:
       - Tue, 17 Apr 2012 15:57:37 GMT
-      content-type: 
+      content-type:
       - application/json; charset=utf-8
-      transfer-encoding: 
+      transfer-encoding:
       - chunked
-      connection: 
+      connection:
       - keep-alive
-      status: 
+      status:
       - 200 OK
-      strict-transport-security: 
+      strict-transport-security:
       - max-age=31536000
-      x-ua-compatible: 
+      x-ua-compatible:
       - IE=Edge,chrome=1
-      etag: 
+      etag:
       - "\"e5be3080253b60063d29411e65400701\""
-      cache-control: 
+      cache-control:
       - must-revalidate, private, max-age=0
-      x-runtime: 
+      x-runtime:
       - "0.101455"
-      x-rack-cache: 
+      x-rack-cache:
       - miss
     body: "{\"total_pages\":1,\"votes\":[{\"vote\":{\"created_at\":\"2012-04-09T05:42:37-05:00\",\"user\":{\"id\":36,\"href\":\"https://staging.checkd.in/api/v1/users/36.json\"},\"activity\":{\"id\":18881,\"href\":\"https://staging.checkd.in/api/v1/activities/18881.json\"}}},{\"vote\":{\"created_at\":\"2012-04-08T06:52:18-05:00\",\"user\":{\"id\":36,\"href\":\"https://staging.checkd.in/api/v1/users/36.json\"},\"activity\":{\"id\":18881,\"href\":\"https://staging.checkd.in/api/v1/activities/18881.json\"}}},{\"vote\":{\"created_at\":\"2012-04-08T06:52:12-05:00\",\"user\":{\"id\":36,\"href\":\"https://staging.checkd.in/api/v1/users/36.json\"},\"activity\":{\"id\":18881,\"href\":\"https://staging.checkd.in/api/v1/activities/18881.json\"}}}]}"
     http_version: "1.1"

data/spec/fixtures/vcr_cassettes/Checkdin_Votes/viewing_a_list_of_activities.yml

@@ -1,44 +1,44 @@
---- 
-- !ruby/struct:VCR::HTTPInteraction 
-  request: !ruby/struct:VCR::Request 
+---
+- !ruby/struct:VCR::HTTPInteraction
+  request: !ruby/struct:VCR::Request
     method: :get
-    uri: https://app.checkd.in:443/api/v1/votes?client_id=123456&client_secret=7890
-    body: 
-    headers: 
-      accept: 
+    uri: https://app.checkd.in:443/api/v1/votes?client_id={client_id}&client_secret={client_secret}
+    body:
+    headers:
+      accept:
       - application/json
-      user-agent: 
+      user-agent:
       - checkdin ruby gem 0.2.2
-      accept-encoding: 
+      accept-encoding:
       - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
-  response: !ruby/struct:VCR::Response 
-    status: !ruby/struct:VCR::ResponseStatus 
+  response: !ruby/struct:VCR::Response
+    status: !ruby/struct:VCR::ResponseStatus
       code: 200
       message: OK
-    headers: 
-      server: 
+    headers:
+      server:
       - nginx/1.0.11
-      date: 
+      date:
       - Tue, 17 Apr 2012 15:57:36 GMT
-      content-type: 
+      content-type:
       - application/json; charset=utf-8
-      transfer-encoding: 
+      transfer-encoding:
       - chunked
-      connection: 
+      connection:
       - keep-alive
-      status: 
+      status:
       - 200 OK
-      strict-transport-security: 
+      strict-transport-security:
       - max-age=31536000
-      x-ua-compatible: 
+      x-ua-compatible:
       - IE=Edge,chrome=1
-      etag: 
+      etag:
       - "\"0b1ec43ded6cc7875c4c284e7e112874\""
-      cache-control: 
+      cache-control:
       - must-revalidate, private, max-age=0
-      x-runtime: 
+      x-runtime:
       - "0.047213"
-      x-rack-cache: 
+      x-rack-cache:
       - miss
     body: "{\"total_pages\":1,\"votes\":[{\"vote\":{\"created_at\":\"2012-04-09T05:42:37-05:00\",\"user\":{\"id\":36,\"href\":\"https://staging.checkd.in/api/v1/users/36.json\"},\"activity\":{\"id\":18881,\"href\":\"https://staging.checkd.in/api/v1/activities/18881.json\"}}},{\"vote\":{\"created_at\":\"2012-04-09T05:38:50-05:00\",\"user\":null,\"activity\":{\"id\":18881,\"href\":\"https://staging.checkd.in/api/v1/activities/18881.json\"}}},{\"vote\":{\"created_at\":\"2012-04-08T06:52:18-05:00\",\"user\":{\"id\":36,\"href\":\"https://staging.checkd.in/api/v1/users/36.json\"},\"activity\":{\"id\":18881,\"href\":\"https://staging.checkd.in/api/v1/activities/18881.json\"}}},{\"vote\":{\"created_at\":\"2012-04-08T06:52:12-05:00\",\"user\":{\"id\":36,\"href\":\"https://staging.checkd.in/api/v1/users/36.json\"},\"activity\":{\"id\":18881,\"href\":\"https://staging.checkd.in/api/v1/activities/18881.json\"}}},{\"vote\":{\"created_at\":\"2012-04-08T06:51:53-05:00\",\"user\":null,\"activity\":{\"id\":18881,\"href\":\"https://staging.checkd.in/api/v1/activities/18881.json\"}}},{\"vote\":{\"created_at\":\"2012-04-08T06:30:05-05:00\",\"user\":null,\"activity\":{\"id\":18881,\"href\":\"https://staging.checkd.in/api/v1/activities/18881.json\"}}},{\"vote\":{\"created_at\":\"2012-04-08T06:26:47-05:00\",\"user\":null,\"activity\":{\"id\":18881,\"href\":\"https://staging.checkd.in/api/v1/activities/18881.json\"}}}]}"
     http_version: "1.1"

data/spec/fixtures/vcr_cassettes/Checkdin_WonRewards/viewing_a_list_of_won_rewards.yml

@@ -2,8 +2,8 @@
 - !ruby/struct:VCR::HTTPInteraction
   request: !ruby/struct:VCR::Request
     method: :get
-    uri: https://app.checkd.in:443/api/v1/won_rewards?client_id=123456&client_secret=7890&limit=2
-    body: !!null 
+    uri: https://app.checkd.in:443/api/v1/won_rewards?client_id={client_id}&client_secret={client_secret}&limit=2
+    body: !!null
     headers:
       accept:
       - application/json

data/spec/fixtures/vcr_cassettes/Checkdin_WonRewards/viewing_a_single_won_reward.yml

@@ -2,8 +2,8 @@
 - !ruby/struct:VCR::HTTPInteraction
   request: !ruby/struct:VCR::Request
     method: :get
-    uri: https://app.checkd.in:443/api/v1/won_rewards/142?client_id=123456&client_secret=7890
-    body: !!null 
+    uri: https://app.checkd.in:443/api/v1/won_rewards/142?client_id={client_id}&client_secret={client_secret}
+    body: !!null
     headers:
       accept:
       - application/json

data/spec/spec_helper.rb

@@ -9,6 +9,8 @@ require 'rspec'
 require 'webmock/rspec'
 require 'vcr'
 
+Dir["./spec/support/**/*.rb"].each {|f| require f}
+
 # Disallow all HTTP connections
 WebMock.disable_net_connect!
 
@@ -17,6 +19,14 @@ VCR.config do |config|
   config.cassette_library_dir = File.join('spec', 'fixtures', 'vcr_cassettes')
 
   config.stub_with :webmock
+
+  config.filter_sensitive_data('{client_id}')     { TestCredentials.client_id }
+  config.filter_sensitive_data('{client_secret}') { TestCredentials.client_secret }
+  config.filter_sensitive_data('{api_url}')       { TestCredentials.api_url }
+
+  config.default_cassette_options = {
+    :match_requests_on => [ :path ] # ignore hostname when finding a matching request in the VCR recording
+  }
 end
 
 RSpec.configure do |config|
@@ -36,4 +46,4 @@ RSpec.configure do |config|
   end
 end
 
-DEFAULT_HOST = 'http://www.example.com'
+DEFAULT_HOST = 'http://www.example.com'

metadata

@@ -2,7 +2,7 @@
 name: checkdin
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 0.2.4
+  version: 0.2.5
 platform: ruby
 authors: 
 - Matt Mueller
@@ -19,10 +19,7 @@ dependencies:
   requirement: &id001 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        version: "0.6"
-    - - <
+    - - ~>
       - !ruby/object:Gem::Version 
         version: "0.8"
   type: :runtime
@@ -35,7 +32,7 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        version: "0.8"
+        version: "0"
   type: :runtime
   version_requirements: *id002
 - !ruby/object:Gem::Dependency