hashblue 0.0.5 → 0.0.8

data/README.md

@@ -4,7 +4,9 @@ This gem provides an easy way to access the hashblue API (https://api.hashblue.c
 
 Using this gem is very straightforward.  First, you need to obtain an OAuth2 access token (see https://api.hashblue.com/doc/Authentication).  Then, create a new client:
 
-    account = Hashblue::Account.authenticate('oauth2-access-token')
+    account = Hashblue::Account.authenticate(
+      Hashblue::AccessToken.new('oauth2-access-token')
+    )
 
 Finally, use that client to start to navigate the API:
 

data/hashblue.gemspec

@@ -5,8 +5,8 @@ require "hashblue/version"
 Gem::Specification.new do |s|
   s.name        = "hashblue"
   s.version     = Hashblue::VERSION
-  s.authors     = ["Tom Ward"]
-  s.email       = ["tom@popdog.net"]
+  s.authors     = ["Tom Ward","Richard Spence"]
+  s.email       = ["tom@popdog.net","richard.spence@o2.com"]
   s.homepage    = "https://api.hashblue.com"
   s.summary     = %q{A simple client for the hashblue api}
   s.description = %q{A simple client for the hashblue api}
@@ -20,6 +20,7 @@ Gem::Specification.new do |s|
 
   s.add_dependency 'httparty', '~>0.7.8'
   s.add_dependency 'activesupport', '~>3.0'
+  s.add_dependency 'json'
 
   s.add_development_dependency 'rake', '~>0.9.2'
   s.add_development_dependency 'rspec', '~>2.6.0'

data/lib/hashblue.rb

@@ -1,4 +1,5 @@
 module Hashblue
+  autoload :AccessToken, 'hashblue/access_token'
   autoload :Account, 'hashblue/account'
   autoload :Client, 'hashblue/client'
   autoload :Collection, 'hashblue/collection'

data/lib/hashblue/access_token.rb

@@ -0,0 +1,33 @@
+module Hashblue
+  class AccessToken
+    def initialize(access_token)
+      @access_token = access_token
+    end
+
+    def to_s
+      @access_token
+    end
+
+    def valid?
+      client.head '/account'
+      true
+    rescue Client::RequestError
+      false
+    end
+
+    def refresh_with(client_identifier, client_secret, refresh_token)
+      response = client.post '/oauth/access_token', {
+        'grant_type' => 'refresh_token',
+        'refresh_token' => refresh_token,
+        'client_id' => client_identifier,
+        'client_secret' => client_secret
+      }, nil
+      @access_token = response["access_token"]
+      response
+    end
+
+    def client
+      @client ||= Client.new(self)
+    end
+  end
+end

data/lib/hashblue/account.rb

@@ -4,7 +4,7 @@ module Hashblue
       def authenticate(access_token)
         client = Hashblue::Client.new(access_token)
         response = client.get("/account")
-        Account.new(client, response["account"])
+        Account.build(client, response["account"])
       end
     end
 

data/lib/hashblue/client.rb

@@ -1,18 +1,26 @@
 require 'httparty'
 require 'active_support/ordered_hash'
-require 'active_support/json'
+require 'json'
 
 module Hashblue
+  
+  class JsonParser < HTTParty::Parser
+    def json
+      ::JSON.parse(body)
+    end
+  end
+  
+  
   class Client
     class RequestError < StandardError; end
 
     include HTTParty
+    parser JsonParser
 
     base_uri "https://api.hashblue.com"
     headers 'Accept' => 'application/json',
             'User-Agent' => "Hashblue Client Gem v#{Hashblue::VERSION} (https://github.com/freerange/hashblue-gem)"
 
-
     attr_reader :access_token
 
     def initialize(access_token)
@@ -27,6 +35,10 @@ module Hashblue
       Collection.new(self, Contact, get(uri, query), "contacts")
     end
 
+    def head(path, query = {})
+      request :head, path, query
+    end
+
     def get(path, query = {})
       request :get, path, query
     end
@@ -49,7 +61,7 @@ module Hashblue
       options = {:query => query, :headers => self.class.headers.merge(authorization_header)}
       if body
         options[:headers]["Content-type"] = "application/json"
-        options[:body] = ActiveSupport::JSON.encode(body)
+        options[:body] = JSON::JSON.parse(body)
       end
 
       response = self.class.send method, path, options

data/lib/hashblue/collection.rb

@@ -5,7 +5,7 @@ class Hashblue::Collection
     @data = data
     @name = name
     @items = @data[name].collect do |item|
-      model_class.new(@client, item)
+      model_class.build(client, item)
     end
   end
 

data/lib/hashblue/message.rb

@@ -3,7 +3,7 @@ module Hashblue
     attribute_methods :uri, :timestamp, :content
 
     def contact
-      @contact ||= Contact.new(client, @attributes["contact"])
+      @contact ||= Contact.build(client, @attributes["contact"])
     end
 
     def sent?

data/lib/hashblue/model.rb

@@ -2,7 +2,7 @@ module Hashblue
   class Model
     attr_accessor :client
 
-    def initialize(client, attributes)
+    def initialize(attributes)
       @client = client
       @attributes = attributes
     end
@@ -15,10 +15,16 @@ module Hashblue
       m.is_a?(self.class) && m.attributes.eql?(attributes)
     end
 
-    def self.attribute_methods(*names)
-      names.each do |name|
-        define_method(name) do
-          @attributes[name.to_s]
+    class << self
+      def build(client, attributes = {})
+        new(attributes).tap {|m| m.client = client}
+      end
+
+      def attribute_methods(*names)
+        names.each do |name|
+          define_method(name) do
+            @attributes[name.to_s]
+          end
         end
       end
     end

data/lib/hashblue/version.rb

@@ -1,3 +1,3 @@
 module Hashblue
-  VERSION = "0.0.5"
+  VERSION = "0.0.8"
 end

data/spec/models/access_token_spec.rb

@@ -0,0 +1,52 @@
+require 'spec_helper'
+
+describe Hashblue::AccessToken do
+  subject do
+    Hashblue::AccessToken.new('access-token')
+  end
+
+  describe '#to_s' do
+    it 'returns the access token' do
+      subject.to_s.should eql('access-token')
+    end
+  end
+
+  describe 'valid?' do
+    it 'is true if a request to /account succeeds' do
+      subject.client.stubs(:head).returns
+      subject.valid?.should be_true
+    end
+
+    it 'is false if a request to /account raises a RequestError' do
+      subject.client.stubs(:head).raises(Hashblue::Client::RequestError)
+      subject.valid?.should be_false
+    end
+  end
+
+  describe 'refresh_with' do
+    before :each do
+      @response = {
+        "expires_in" => 2592000,
+        "refresh_token" => "new-refresh-token",
+        "access_token"=>"new-access-token"
+      }
+
+      subject.client.expects(:post).with('/oauth/access_token', {
+        'grant_type' => 'refresh_token',
+        'refresh_token' => 'provided-refresh-token',
+        'client_id' => 'client-identifier',
+        'client_secret' => 'client-secret'
+      }, nil).returns(@response)
+    end
+
+    it 'returns response' do
+      response = subject.refresh_with('client-identifier', 'client-secret', 'provided-refresh-token')
+      response.should eql(@response)
+    end
+
+    it 'updates its own access token' do
+      subject.refresh_with('client-identifier', 'client-secret', 'provided-refresh-token')
+      subject.to_s.should == @response["access_token"]
+    end
+  end
+end

data/spec/models/account_spec.rb

@@ -6,11 +6,11 @@ describe Hashblue::Account do
   end
 
   subject do
-    Hashblue::Account.new(client, {
+    Hashblue::Account.new(
       'messages' => 'https://api.example.com/messages',
       'contacts' => 'https://api.example.com/contacts',
       'favourite_messages' => 'https://api.example.com/messages/favourites'
-    })
+    ).tap {|a| a.client = client}
   end
 
   describe '.authenticate' do
@@ -20,7 +20,7 @@ describe Hashblue::Account do
         "msisdn" => "4479001234567"
       }
       client.stubs(:get).with('/account').returns("account" => attributes)
-      Hashblue::Account.authenticate('access-token').should eql(Hashblue::Account.new(client, attributes))
+      Hashblue::Account.authenticate('access-token').should eql(Hashblue::Account.new(attributes))
     end
   end
 

data/spec/models/collection_spec.rb

@@ -13,10 +13,14 @@ describe Hashblue::Collection do
     end
 
     it "passes array methods to an array of models built from provided data" do
-      subject[0].should eql(Hashblue::Contact.new(client, {'msisdn' => 1}))
+      subject[0].should eql(Hashblue::Contact.new('msisdn' => 1))
       subject.size.should eql(3)
       subject.collect {|c| c.msisdn}.should eql([1, 2, 3])
     end
+
+    it "sets client on each model in array" do
+      subject.collect{|c| c.client}.uniq.should eql([client])
+    end
   end
 
   describe "a collection without a next_page_uri" do

data/spec/models/contact_spec.rb

@@ -6,10 +6,10 @@ describe Hashblue::Contact do
   end
 
   subject do
-    Hashblue::Contact.new(client, {
+    Hashblue::Contact.new(
       'uri' => 'https://api.example.com/contacts/abcdef123456',
-      'messages' => 'https://api.example.com/contact/1/messages',
-    })
+      'messages' => 'https://api.example.com/contact/1/messages'
+    ).tap {|c| c.client = client }
   end
 
   describe '#messages' do

data/spec/models/message_spec.rb

@@ -6,14 +6,14 @@ describe Hashblue::Message do
   end
 
   subject do
-    Hashblue::Message.new(client, {
+    Hashblue::Message.new(
       'uri' => 'https://api.example.com/messages/abcdef123456',
       'sent' => true,
       'favourite' => false,
       'contact' => {
         'messages' => 'https://api.example.com/contacts/2/messages'
       }
-    })
+    ).tap {|m| m.client = client }
   end
 
   describe 'favourite?' do
@@ -30,9 +30,9 @@ describe Hashblue::Message do
 
   describe '#contact' do
     it "returns Contact built with contact attributes" do
-      subject.contact.should eql(Hashblue::Contact.new(client, {
+      subject.contact.should eql(Hashblue::Contact.new(
         'messages' => 'https://api.example.com/contacts/2/messages'
-      }))
+      ))
     end
   end
 

metadata

@@ -1,24 +1,26 @@
 --- !ruby/object:Gem::Specification 
 name: hashblue
 version: !ruby/object:Gem::Version 
-  hash: 21
+  hash: 15
   prerelease: 
   segments: 
   - 0
   - 0
-  - 5
-  version: 0.0.5
+  - 8
+  version: 0.0.8
 platform: ruby
 authors: 
 - Tom Ward
+- Richard Spence
 autorequire: 
 bindir: bin
 cert_chain: []
 
-date: 2011-06-24 00:00:00 Z
+date: 2011-09-29 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
-  type: :runtime
+  name: httparty
+  prerelease: false
   requirement: &id001 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
@@ -30,11 +32,11 @@ dependencies:
         - 7
         - 8
         version: 0.7.8
+  type: :runtime
   version_requirements: *id001
-  name: httparty
-  prerelease: false
 - !ruby/object:Gem::Dependency 
-  type: :runtime
+  name: activesupport
+  prerelease: false
   requirement: &id002 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
@@ -45,12 +47,26 @@ dependencies:
         - 3
         - 0
         version: "3.0"
+  type: :runtime
   version_requirements: *id002
-  name: activesupport
-  prerelease: false
 - !ruby/object:Gem::Dependency 
-  type: :development
+  name: json
+  prerelease: false
   requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: rake
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
@@ -61,12 +77,12 @@ dependencies:
         - 9
         - 2
         version: 0.9.2
-  version_requirements: *id003
-  name: rake
-  prerelease: false
-- !ruby/object:Gem::Dependency 
   type: :development
-  requirement: &id004 !ruby/object:Gem::Requirement 
+  version_requirements: *id004
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id005 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
@@ -77,12 +93,12 @@ dependencies:
         - 6
         - 0
         version: 2.6.0
-  version_requirements: *id004
-  name: rspec
-  prerelease: false
-- !ruby/object:Gem::Dependency 
   type: :development
-  requirement: &id005 !ruby/object:Gem::Requirement 
+  version_requirements: *id005
+- !ruby/object:Gem::Dependency 
+  name: mocha
+  prerelease: false
+  requirement: &id006 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
@@ -91,12 +107,12 @@ dependencies:
         segments: 
         - 0
         version: "0"
-  version_requirements: *id005
-  name: mocha
-  prerelease: false
+  type: :development
+  version_requirements: *id006
 description: A simple client for the hashblue api
 email: 
 - tom@popdog.net
+- richard.spence@o2.com
 executables: []
 
 extensions: []
@@ -112,6 +128,7 @@ files:
 - Rakefile
 - hashblue.gemspec
 - lib/hashblue.rb
+- lib/hashblue/access_token.rb
 - lib/hashblue/account.rb
 - lib/hashblue/client.rb
 - lib/hashblue/collection.rb
@@ -119,6 +136,7 @@ files:
 - lib/hashblue/message.rb
 - lib/hashblue/model.rb
 - lib/hashblue/version.rb
+- spec/models/access_token_spec.rb
 - spec/models/account_spec.rb
 - spec/models/client_spec.rb
 - spec/models/collection_spec.rb
@@ -154,11 +172,12 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: hashblue
-rubygems_version: 1.8.5
+rubygems_version: 1.8.10
 signing_key: 
 specification_version: 3
 summary: A simple client for the hashblue api
 test_files: 
+- spec/models/access_token_spec.rb
 - spec/models/account_spec.rb
 - spec/models/client_spec.rb
 - spec/models/collection_spec.rb