zero_push 1.2.0 → 1.3.0

data/Gemfile.lock

@@ -1,8 +1,9 @@
 PATH
   remote: .
   specs:
-    zero_push (1.2.0)
+    zero_push (1.3.0)
       faraday (~> 0.8.5)
+      faraday_middleware (~> 0.9.0)
 
 GEM
   remote: https://rubygems.org/
@@ -25,8 +26,10 @@ GEM
       multi_json (~> 1.0)
     builder (3.0.4)
     erubis (2.7.0)
-    faraday (0.8.7)
-      multipart-post (~> 1.1)
+    faraday (0.8.8)
+      multipart-post (~> 1.2.0)
+    faraday_middleware (0.9.0)
+      faraday (>= 0.7.4, < 0.9)
     hike (1.2.1)
     i18n (0.6.1)
     journey (1.0.4)

data/lib/zero_push/client.rb

@@ -1,57 +1,39 @@
+require 'faraday_middleware'
+
 module ZeroPush
-  URL = "https://api.zeropush.com"
+  class Client
 
-  class << self
-    attr_accessor :auth_token
+    def initialize(auth_token)
+      @faraday = Faraday.new(url: ZeroPush::URL) do |c|
+        c.token_auth auth_token                        # Set the Authorization header
+        c.request    :url_encoded                      # form-encode POST params
+        c.response   :json, :content_type => /\bjson$/ # parse responses to JSON
+        c.adapter    Faraday.default_adapter           # Net::HTTP
+      end
+    end
 
-    # verifies credentials
-    #
-    # @return [Boolean]
     def verify_credentials
-      response = client.get('/verify_credentials')
+      response = faraday.get('/verify_credentials')
       response.status == 200
     end
 
-    # Sends a notification to the list of devices
-    #
-    # @param params [Hash]
-    # @return response
     def notify(params)
-      client.post('/notify', params)
+      faraday.post('/notify', params)
     end
 
-    # Registers a device token with the ZeroPush backend
-    #
-    # @param device_token
-    # @return response
     def register(device_token)
-      client.post('/register', device_token: device_token)
+      faraday.post('/register', device_token: device_token)
     end
 
-    # Sets the badge for a particular device
-    #
-    # @param device_token
-    # @param badge
-    # @return response
     def set_badge(device_token, badge)
-      client.post('/set_badge', device_token: device_token, badge: badge)
+      faraday.post('/set_badge', device_token: device_token, badge: badge)
     end
 
-    # Returns a list of tokens that have been marked inactive
-    #
-    # @returns array
     def inactive_tokens
-      client.get('/inactive_tokens')
+      faraday.get('/inactive_tokens')
     end
 
-    # the HTTP client configured for API requests
-    #
-    def client
-      Faraday.new(url: URL) do |c|
-        c.token_auth  self.auth_token
-        c.request     :url_encoded            # form-encode POST params
-        c.adapter     Faraday.default_adapter # Net::HTTP
-      end
-    end
+    private
+      attr_reader :faraday
   end
 end

data/lib/zero_push/version.rb

@@ -1,3 +1,3 @@
 module ZeroPush
-  VERSION = "1.2.0"
+  VERSION = "1.3.0"
 end

data/lib/zero_push.rb

@@ -1,3 +1,61 @@
-require 'zero_push/version'
-require 'zero_push/client'
 require 'faraday'
+require 'zero_push/client'
+require 'zero_push/version'
+
+module ZeroPush
+  URL = "https://api.zeropush.com"
+
+  class << self
+    attr_accessor :auth_token
+
+    # verifies credentials
+    #
+    # @return [Boolean]
+    def verify_credentials
+      response = client.get('/verify_credentials')
+      response.status == 200
+    end
+
+    # Sends a notification to the list of devices
+    #
+    # @param params [Hash]
+    # @return response
+    def notify(params)
+      client.post('/notify', params)
+    end
+
+    # Registers a device token with the ZeroPush backend
+    #
+    # @param device_token
+    # @return response
+    def register(device_token)
+      client.post('/register', device_token: device_token)
+    end
+
+    # Sets the badge for a particular device
+    #
+    # @param device_token
+    # @param badge
+    # @return response
+    def set_badge(device_token, badge)
+      client.post('/set_badge', device_token: device_token, badge: badge)
+    end
+
+    # Returns a list of tokens that have been marked inactive
+    #
+    # @returns array
+    def inactive_tokens
+      client.get('/inactive_tokens')
+    end
+
+    # the HTTP client configured for API requests
+    #
+    def client
+      Faraday.new(url: URL) do |c|
+        c.token_auth  self.auth_token
+        c.request     :url_encoded            # form-encode POST params
+        c.adapter     Faraday.default_adapter # Net::HTTP
+      end
+    end
+  end
+end

data/spec/fixtures/inactive_tokens.yml

@@ -10,7 +10,7 @@ http_interactions:
       Authorization: 
       - Token token="test_token"
       User-Agent: 
-      - Faraday v0.8.7
+      - Faraday v0.8.8
   response: 
     status: 
       code: 200

data/spec/fixtures/notify.yml

@@ -10,7 +10,7 @@ http_interactions:
       Authorization:
       - Token token="test_token"
       User-Agent:
-      - Faraday v0.8.7
+      - Faraday v0.8.8
       Content-Type:
       - application/x-www-form-urlencoded
   response:

data/spec/fixtures/register.yml

@@ -10,7 +10,7 @@ http_interactions:
       Authorization:
       - Token token="test_token"
       User-Agent:
-      - Faraday v0.8.7
+      - Faraday v0.8.8
       Content-Type:
       - application/x-www-form-urlencoded
   response:

data/spec/fixtures/set_badge.yml

@@ -10,7 +10,7 @@ http_interactions:
       Authorization:
       - Token token="test_token"
       User-Agent:
-      - Faraday v0.8.7
+      - Faraday v0.8.8
       Content-Type:
       - application/x-www-form-urlencoded
   response:

data/spec/fixtures/verify_credentials.yml

@@ -10,7 +10,7 @@ http_interactions:
       Authorization:
       - Token token="test_token"
       User-Agent:
-      - Faraday v0.8.7
+      - Faraday v0.8.8
   response:
     status:
       code: 200
@@ -74,7 +74,7 @@ http_interactions:
       Authorization:
       - Token token="not a valid token"
       User-Agent:
-      - Faraday v0.8.7
+      - Faraday v0.8.8
   response:
     status:
       code: 401

data/spec/zero_push_client_spec.rb

@@ -0,0 +1,130 @@
+require 'spec_helper'
+
+describe ZeroPush::Client do
+
+  let(:auth_token){ENV["AUTH_TOKEN"] || "test_token"}
+  let(:verified_client){ZeroPush::Client.new(auth_token)}
+  let(:unverified_client){ZeroPush::Client.new("not a valid token")}
+
+  describe "#verify_credentials" do
+    before do
+      VCR.insert_cassette "verify_credentials"
+    end
+
+    after do
+      VCR.eject_cassette
+    end
+
+    describe "for a verified client" do
+      let(:response){verified_client.verify_credentials}
+
+      it "should verify credentials successfully" do
+        response.must_equal true
+      end
+    end
+
+    describe "for an unverified client" do
+      let(:response){unverified_client.verify_credentials}
+
+      it "should fail to verify credentials" do
+        response.must_equal false
+      end
+    end
+  end
+
+  describe "#notify" do
+    before do
+      VCR.insert_cassette "notify"
+    end
+
+    after do
+      VCR.eject_cassette
+    end
+
+    let(:response){verified_client.notify(device_tokens: ['abc'], alert: 'hi')}
+
+    it "should return a Faraday::Response" do
+      response.class.must_equal Faraday::Response
+    end
+
+    it "should return a Hash for a response body" do
+      response.body.class.must_equal Hash
+    end
+
+    it "should be successful" do
+      response.status.must_equal 200
+    end
+  end
+
+  describe "#register" do
+    before do
+      VCR.insert_cassette "register"
+    end
+
+    after do
+      VCR.eject_cassette
+    end
+
+    let(:response){verified_client.register('abc')}
+
+    it "should return a Faraday::Response" do
+      response.class.must_equal Faraday::Response
+    end
+
+    it "should return a Hash for a response body" do
+      response.body.class.must_equal Hash
+    end
+
+    it "should register the device" do
+      response.status.must_equal 200
+    end
+  end
+
+  describe "#set_badge" do
+    before do
+      VCR.insert_cassette "set_badge"
+    end
+
+    after do
+      VCR.eject_cassette
+    end
+
+    let(:response){verified_client.set_badge('abc', 10)}
+
+    it "should return a Faraday::Response" do
+      response.class.must_equal Faraday::Response
+    end
+
+    it "should return a Hash for a response body" do
+      response.body.class.must_equal Hash
+    end
+
+    it "should set the device's badge" do
+      response.status.must_equal 200
+    end
+  end
+
+  describe "#inactive_tokens" do
+    before do
+      VCR.insert_cassette "inactive_tokens"
+    end
+
+    after do
+      VCR.eject_cassette
+    end
+
+    let(:response){verified_client.inactive_tokens}
+
+    it "should return a Faraday::Response" do
+      response.class.must_equal Faraday::Response
+    end
+
+    it "should return an Array for a response body" do
+      response.body.class.must_equal Array
+    end
+
+    it "should get a list of inactive tokens" do
+      response.status.must_equal 200
+    end
+  end
+end

data/spec/zero_push_spec.rb

@@ -1,11 +1,21 @@
 require 'spec_helper'
+require 'json'
 
 describe ZeroPush do
   before do
     ZeroPush.auth_token = ENV["AUTH_TOKEN"] || "test_token"
   end
 
-  describe "/verify_credentials" do
+  describe ".client" do
+
+    let(:client){ZeroPush.client}
+
+    it "should return a Faraday client" do
+      client.class.must_equal Faraday::Connection
+    end
+  end
+
+  describe ".verify_credentials" do
     before do
       VCR.insert_cassette "verify_credentials"
     end
@@ -14,17 +24,19 @@ describe ZeroPush do
       VCR.eject_cassette
     end
 
+    let(:response){ZeroPush.verify_credentials}
+
     it "should verify credentials successfully" do
-      ZeroPush.verify_credentials.must_equal true
+      response.must_equal true
     end
 
     it "should fail to verify credentials" do
       ZeroPush.auth_token = "not a valid token"
-      ZeroPush.verify_credentials.must_equal false
+      response.must_equal false
     end
   end
 
-  describe "/notify" do
+  describe ".notify" do
     before do
       VCR.insert_cassette "notify"
     end
@@ -33,13 +45,22 @@ describe ZeroPush do
       VCR.eject_cassette
     end
 
-    it "should construct the request" do
-      response = ZeroPush.notify(device_tokens: ['abc'], alert: 'hi')
+    let(:response){ZeroPush.notify(device_tokens: ['abc'], alert: 'hi')}
+
+    it "should return a Faraday::Response" do
+      response.class.must_equal Faraday::Response
+    end
+
+    it "should return a response with a body that can be parsed into a Hash" do
+      JSON.parse(response.body).class.must_equal Hash
+    end
+
+    it "should be successful" do
       response.status.must_equal 200
     end
   end
 
-  describe "/register" do
+  describe ".register" do
     before do
       VCR.insert_cassette "register"
     end
@@ -48,13 +69,22 @@ describe ZeroPush do
       VCR.eject_cassette
     end
 
+    let(:response){ZeroPush.register('abc')}
+
+    it "should return a Faraday::Response" do
+      response.class.must_equal Faraday::Response
+    end
+
+    it "should return a response with a body that can be parsed into a Hash" do
+      JSON.parse(response.body).class.must_equal Hash
+    end
+
     it "should register the device" do
-      response = ZeroPush.register('abc')
       response.status.must_equal 200
     end
   end
 
-  describe "/set_badge" do
+  describe ".set_badge" do
     before do
       VCR.insert_cassette "set_badge"
     end
@@ -63,13 +93,22 @@ describe ZeroPush do
       VCR.eject_cassette
     end
 
+    let(:response){ZeroPush.set_badge('abc', 10)}
+
+    it "should return a Faraday::Response" do
+      response.class.must_equal Faraday::Response
+    end
+
+    it "should return a response with a body that can be parsed into a Hash" do
+      JSON.parse(response.body).class.must_equal Hash
+    end
+
     it "should set the device's badge" do
-      response = ZeroPush.set_badge('abc', 10)
       response.status.must_equal 200
     end
   end
 
-  describe "/inactive_tokens" do
+  describe ".inactive_tokens" do
     before do
       VCR.insert_cassette "inactive_tokens"
     end
@@ -78,8 +117,17 @@ describe ZeroPush do
       VCR.eject_cassette
     end
 
+    let(:response){ZeroPush.inactive_tokens}
+
+    it "should return a Faraday::Response" do
+      response.class.must_equal Faraday::Response
+    end
+
+    it "should return a response with a body that can be parsed into an Array" do
+      JSON.parse(response.body).class.must_equal Array
+    end
+
     it "should get a list of inactive tokens" do
-      response = ZeroPush.inactive_tokens
       response.status.must_equal 200
     end
   end

data/zero_push.gemspec

@@ -19,6 +19,7 @@ Gem::Specification.new do |gem|
   gem.required_ruby_version = '>= 1.9'
 
   gem.add_dependency "faraday", "~> 0.8.5"
+  gem.add_dependency  "faraday_middleware", "~> 0.9.0"
 
   gem.add_development_dependency 'actionpack',    '~> 3.2.11'
   gem.add_development_dependency 'activesupport', '~> 3.2.11'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: zero_push
 version: !ruby/object:Gem::Version
-  version: 1.2.0
+  version: 1.3.0
   prerelease: 
 platform: ruby
 authors:
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-08-09 00:00:00.000000000 Z
+date: 2013-08-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -28,6 +28,22 @@ dependencies:
     - - ~>
       - !ruby/object:Gem::Version
         version: 0.8.5
+- !ruby/object:Gem::Dependency
+  name: faraday_middleware
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.9.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.9.0
 - !ruby/object:Gem::Dependency
   name: actionpack
   requirement: !ruby/object:Gem::Requirement
@@ -167,6 +183,7 @@ files:
 - spec/fixtures/verify_credentials.yml
 - spec/generator_spec.rb
 - spec/spec_helper.rb
+- spec/zero_push_client_spec.rb
 - spec/zero_push_spec.rb
 - zero_push.gemspec
 - zeropush-header.png
@@ -202,5 +219,6 @@ test_files:
 - spec/fixtures/verify_credentials.yml
 - spec/generator_spec.rb
 - spec/spec_helper.rb
+- spec/zero_push_client_spec.rb
 - spec/zero_push_spec.rb
 has_rdoc: