checkdin 0.2.8 → 0.2.9

data/Gemfile.lock

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

data/lib/checkdin/client.rb

@@ -13,6 +13,7 @@ module Checkdin
     include Leaderboard
     include Votes
     include Clients
+    include PushApiSubscriptions
 
     attr_reader :client_id, :client_secret
     attr_reader :ssl

data/lib/checkdin/push_api_subscriptions.rb

@@ -0,0 +1,39 @@
+module Checkdin
+  module PushApiSubscriptions
+
+    # Retrieve information about a push API subscription
+    #
+    # param [Integer] id The ID of the subscription
+
+    def push_api_subscription(id)
+      response = connection.get("push_api_subscriptions/#{id}")
+      return_error_or_body(response)
+    end
+
+    # Get a list of all push api subscriptions for the authenticating client.
+
+    def push_api_subscriptions
+      response = connection.get("push_api_subscriptions")
+      return_error_or_body(response)
+    end
+
+    # Enable a push API subscription
+    #
+    # param [Integer] id The ID of the subscription to enable
+
+    def enable_push_api_subscription(id)
+      response = connection.put("push_api_subscriptions/#{id}/enable")
+      return_error_or_body(response)
+    end
+
+    # Disable a push API subscription
+    #
+    # param [Integer] id The ID of the subscription to disable
+
+    def disable_push_api_subscription(id)
+      response = connection.put("push_api_subscriptions/#{id}/disable")
+      return_error_or_body(response)
+    end
+
+  end
+end

data/lib/checkdin/user_bridge.rb

@@ -5,7 +5,7 @@ module Checkdin
     attr :client_identifier, :bridge_secret
     attr :checkdin_landing_url
 
-    # Used to build the authenticated parameters for logging in an end-user on 
+    # Used to build the authenticated parameters for logging in an end-user on
     # checkd.in via a redirect.
     #
     # options              - a hash with a the following values defined:
@@ -52,6 +52,7 @@ module Checkdin
     #   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
+    #   campaign_id           - OPTIONAL, automatically join a user to this campaign, rewarding existing known actions
     #
     # 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.

data/lib/checkdin/users.rb

@@ -45,8 +45,9 @@ module Checkdin
     # @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
+    # @option options Boolean :delivery_email       - OPTIONAL, whether a user should receive email notifications
+    # @option options Boolean :delivery_sms         - OPTIONAL, whether a user should receive sms notifications
+    # @option options Integer :campaign_id          - OPTIONAL, automatically join a user to this campaign, rewarding existing known actions
 
     def create_user(options={})
       response = connection.post do |req|

data/lib/checkdin/version.rb

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

data/lib/checkdin.rb

@@ -16,6 +16,7 @@ require 'checkdin/promotions'
 require 'checkdin/campaigns'
 require 'checkdin/votes'
 require 'checkdin/clients'
+require 'checkdin/push_api_subscriptions'
 require 'checkdin/client'
 require 'checkdin/api_error'
 

data/spec/checkdin/push_api_subscriptions_spec.rb

@@ -0,0 +1,50 @@
+require 'spec_helper'
+
+describe Checkdin::PushApiSubscriptions do
+
+  before do
+    @client = Checkdin::Client.new(TestCredentials.client_args)
+  end
+
+  context "viewing a single push api subscription" do
+    use_vcr_cassette
+    let(:result) { @client.push_api_subscription(1) }
+
+    it "should make the push API subscription's url available" do
+      result.push_api_subscription.push_url.should == "http://test.com"
+    end
+
+    it "should make the push API subscription's push secret available" do
+      result.push_api_subscription.secret.should == "6dec79a3034468c530fc"
+    end
+  end
+
+  context "viewing a list of push api subscriptions" do
+    use_vcr_cassette
+    let(:result) { @client.push_api_subscriptions }
+
+    it "should make a list of push API subscriptions available" do
+      result.count.should == 2
+    end
+  end
+
+  context "enabling a push api subscription" do
+    use_vcr_cassette
+    let(:result) { @client.enable_push_api_subscription(2) }
+
+    it "should enable the subscription and return it" do
+      result.push_api_subscription.state.should == "enabled"
+    end
+  end
+
+  context "disabling a push api subscription" do
+    use_vcr_cassette
+    let(:result) { @client.disable_push_api_subscription(1) }
+
+    it "should disable the subscription and return it" do
+      result.push_api_subscription.state.should == "disabled"
+    end
+  end
+
+
+end

data/spec/fixtures/vcr_cassettes/Checkdin_PushApiSubscriptions/disabling_a_push_api_subscription.yml

@@ -0,0 +1,32 @@
+--- 
+- !ruby/struct:VCR::HTTPInteraction 
+  request: !ruby/struct:VCR::Request 
+    method: :put
+    uri: http://checkd-in-core.dev:80/api/v1/push_api_subscriptions/1/disable?client_id={client_id}&client_secret={client_secret}
+    body: 
+    headers: 
+      accept: 
+      - application/json
+      user-agent: 
+      - checkdin ruby gem 0.2.8
+      content-length: 
+      - "0"
+  response: !ruby/struct:VCR::Response 
+    status: !ruby/struct:VCR::ResponseStatus 
+      code: 200
+      message: OK
+    headers: 
+      content-type: 
+      - application/json; charset=utf-8
+      x-ua-compatible: 
+      - IE=Edge
+      etag: 
+      - "\"5dc194884d762f9b11af7d509861636d\""
+      cache-control: 
+      - max-age=0, private, must-revalidate
+      x-request-id: 
+      - 65ef6ad8a9be72f97cbb4f1480e3f575
+      x-runtime: 
+      - "0.114155"
+    body: "{\"push_api_subscription\":{\"push_url\":\"http://test.com\",\"state\":\"disabled\",\"reward_won_monitored\":false,\"activity_created_monitored\":true,\"user_created_monitored\":false,\"secret\":\"6dec79a3034468c530fc\",\"campaign\":null}}"
+    http_version: "1.1"

data/spec/fixtures/vcr_cassettes/Checkdin_PushApiSubscriptions/enabling_a_push_api_subscription.yml

@@ -0,0 +1,32 @@
+--- 
+- !ruby/struct:VCR::HTTPInteraction 
+  request: !ruby/struct:VCR::Request 
+    method: :put
+    uri: http://checkd-in-core.dev:80/api/v1/push_api_subscriptions/2/enable?client_id={client_id}&client_secret={client_secret}
+    body: 
+    headers: 
+      accept: 
+      - application/json
+      user-agent: 
+      - checkdin ruby gem 0.2.8
+      content-length: 
+      - "0"
+  response: !ruby/struct:VCR::Response 
+    status: !ruby/struct:VCR::ResponseStatus 
+      code: 200
+      message: OK
+    headers: 
+      content-type: 
+      - application/json; charset=utf-8
+      x-ua-compatible: 
+      - IE=Edge
+      etag: 
+      - "\"9f2a4641681422d0e3958302e9dc7f15\""
+      cache-control: 
+      - max-age=0, private, must-revalidate
+      x-request-id: 
+      - 05ba934d598cec7b44ef90346ea4f515
+      x-runtime: 
+      - "0.061926"
+    body: "{\"push_api_subscription\":{\"push_url\":\"http://campaign-specific.com\",\"state\":\"enabled\",\"reward_won_monitored\":false,\"activity_created_monitored\":false,\"user_created_monitored\":true,\"secret\":\"06c5b4a97848faec4a94\",\"campaign\":{\"href\":\"{api_url}/campaigns/7.json\",\"id\":7}}}"
+    http_version: "1.1"

data/spec/fixtures/vcr_cassettes/Checkdin_PushApiSubscriptions/viewing_a_list_of_push_api_subscriptions.yml

@@ -0,0 +1,32 @@
+--- 
+- !ruby/struct:VCR::HTTPInteraction 
+  request: !ruby/struct:VCR::Request 
+    method: :get
+    uri: http://checkd-in-core.dev:80/api/v1/push_api_subscriptions?client_id={client_id}&client_secret={client_secret}
+    body: 
+    headers: 
+      accept: 
+      - application/json
+      user-agent: 
+      - checkdin ruby gem 0.2.8
+      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: 
+      content-type: 
+      - application/json; charset=utf-8
+      x-ua-compatible: 
+      - IE=Edge
+      etag: 
+      - "\"e05a34bf305d4016a48df13b2b82f668\""
+      cache-control: 
+      - max-age=0, private, must-revalidate
+      x-request-id: 
+      - 81063280e22214167c45926165975d79
+      x-runtime: 
+      - "0.161668"
+    body: "[{\"push_api_subscription\":{\"push_url\":\"http://test.com\",\"state\":\"enabled\",\"reward_won_monitored\":false,\"activity_created_monitored\":true,\"user_created_monitored\":false,\"secret\":\"6dec79a3034468c530fc\",\"campaign\":null}},{\"push_api_subscription\":{\"push_url\":\"http://campaign-specific.com\",\"state\":\"disabled\",\"reward_won_monitored\":false,\"activity_created_monitored\":false,\"user_created_monitored\":true,\"secret\":\"06c5b4a97848faec4a94\",\"campaign\":{\"href\":\"{api_url}/campaigns/7.json\",\"id\":7}}}]"
+    http_version: "1.1"

data/spec/fixtures/vcr_cassettes/Checkdin_PushApiSubscriptions/viewing_a_single_push_api_subscription.yml

@@ -0,0 +1,32 @@
+--- 
+- !ruby/struct:VCR::HTTPInteraction 
+  request: !ruby/struct:VCR::Request 
+    method: :get
+    uri: http://checkd-in-core.dev:80/api/v1/push_api_subscriptions/1?client_id={client_id}&client_secret={client_secret}
+    body: 
+    headers: 
+      accept: 
+      - application/json
+      user-agent: 
+      - checkdin ruby gem 0.2.8
+      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: 
+      content-type: 
+      - application/json; charset=utf-8
+      x-ua-compatible: 
+      - IE=Edge
+      etag: 
+      - "\"9d54b3e26adb43319412054e434f95b4\""
+      cache-control: 
+      - max-age=0, private, must-revalidate
+      x-request-id: 
+      - 229fde8356e2089293d1970696570ade
+      x-runtime: 
+      - "0.135453"
+    body: "{\"push_api_subscription\":{\"push_url\":\"http://test.com\",\"state\":\"enabled\",\"reward_won_monitored\":false,\"activity_created_monitored\":true,\"user_created_monitored\":false,\"secret\":\"6dec79a3034468c530fc\",\"campaign\":null}}"
+    http_version: "1.1"

metadata

@@ -2,7 +2,7 @@
 name: checkdin
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 0.2.8
+  version: 0.2.9
 platform: ruby
 authors: 
 - Matt Mueller
@@ -159,6 +159,7 @@ files:
 - lib/checkdin/custom_activities.rb
 - lib/checkdin/leaderboard.rb
 - lib/checkdin/promotions.rb
+- lib/checkdin/push_api_subscriptions.rb
 - lib/checkdin/users.rb
 - lib/checkdin/user_bridge.rb
 - lib/checkdin/version.rb
@@ -171,6 +172,7 @@ files:
 - spec/checkdin/custom_activities_spec.rb
 - spec/checkdin/leaderboard_spec.rb
 - spec/checkdin/promotions_spec.rb
+- spec/checkdin/push_api_subscriptions_spec.rb
 - spec/checkdin/users_spec.rb
 - spec/checkdin/user_bridge_spec.rb
 - spec/checkdin/won_rewards_spec.rb
@@ -188,6 +190,10 @@ files:
 - 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
 - spec/fixtures/vcr_cassettes/Checkdin_Promotions/viewing_the_votes_leaderboard_for_a_promotion/limiting_the_number_of_records_returned.yml
+- spec/fixtures/vcr_cassettes/Checkdin_PushApiSubscriptions/disabling_a_push_api_subscription.yml
+- spec/fixtures/vcr_cassettes/Checkdin_PushApiSubscriptions/enabling_a_push_api_subscription.yml
+- spec/fixtures/vcr_cassettes/Checkdin_PushApiSubscriptions/viewing_a_list_of_push_api_subscriptions.yml
+- spec/fixtures/vcr_cassettes/Checkdin_PushApiSubscriptions/viewing_a_single_push_api_subscription.yml
 - spec/fixtures/vcr_cassettes/Checkdin_Users/viewing_a_list_of_users.yml
 - spec/fixtures/vcr_cassettes/Checkdin_Users/viewing_a_single_user.yml
 - spec/fixtures/vcr_cassettes/Checkdin_Votes/filtering_by_a_single_user.yml