hashblue 0.0.2 → 0.0.3

data/README.md

@@ -4,20 +4,20 @@ 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:
 
-    client = Hashblue::Client.new('oauth2-access-token')
+    account = Hashblue::Account.authenticate('oauth2-access-token')
 
 Finally, use that client to start to navigate the API:
 
-    contacts = client.account.contacts
+    contacts = account.contacts
     first_contact_messages = contacts.first.messages
 
 You can also pass in query parameters to restrict the results:
 
-    messages_abouts_pubs = client.messages(:q => 'pub')
+    messages_abouts_pubs = account.messages(:q => 'pub')
 
 And if there are additional pages of results, access them too:
 
-    second_page = client.messages(:q => 'pub').next_page
+    second_page = account.messages(:q => 'pub').next_page
 
 It's possible to delete messages, and mark them as favourites:
 

data/hashblue.gemspec

@@ -19,6 +19,7 @@ Gem::Specification.new do |s|
   s.require_paths = ["lib"]
 
   s.add_dependency 'httparty', '~>0.7.8'
+  s.add_dependency 'activesupport', '~>3.0'
 
   s.add_development_dependency 'rake', '~>0.9.2'
   s.add_development_dependency 'rspec', '~>2.6.0'

data/lib/hashblue/account.rb

@@ -1,5 +1,13 @@
 module Hashblue
   class Account < Model
+    class << self
+      def authenticate(access_token)
+        client = Hashblue::Client.new(access_token)
+        response = client.get("/account")
+        Account.new(client, response["account"])
+      end
+    end
+
     attribute_methods :msisdn, :phone_number, :email
 
     def messages(query = {})
@@ -10,6 +18,10 @@ module Hashblue
       client.load_contacts(contacts_uri, query)
     end
 
+    def favourite_messages(query = {})
+      client.load_messages(favourite_messages_uri, query)
+    end
+
     def messages_uri
       @attributes["messages"]
     end
@@ -17,5 +29,9 @@ module Hashblue
     def contacts_uri
       @attributes["contacts"]
     end
+
+    def favourite_messages_uri
+      @attributes["favourite_messages"]
+    end
   end
 end

data/lib/hashblue/client.rb

@@ -1,4 +1,6 @@
 require 'httparty'
+require 'active_support/ordered_hash'
+require 'active_support/json'
 
 module Hashblue
   class Client
@@ -7,28 +9,14 @@ module Hashblue
     include HTTParty
 
     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, :refresh_token
 
-    def initialize(access_token, refresh_token = nil)
-      @access_token = access_token
-      @refresh_token = refresh_token
-    end
-
-    def account
-      @account ||= Account.new(self, get("/account")["account"])
-    end
+    attr_reader :access_token
 
-    def messages(query = {})
-      load_messages("/messages", query)
-    end
-
-    def favourites(query = {})
-      load_messages("/messages/favourites", query)
-    end
-
-    def contacts(query = {})
-      load_contacts("/contacts", query)
+    def initialize(access_token)
+      @access_token = access_token
     end
 
     def load_messages(uri, query = {})
@@ -51,18 +39,30 @@ module Hashblue
       request :put, path, query, body
     end
 
+    def post(path, query, body)
+      request :post, path, query, body
+    end
+
     private
 
     def request(method, path, query, body = nil)
-      response = self.class.send method, path, :query => query, :headers => request_headers
-      case response.headers["status"]
-      when "200" then response.to_hash
-      else raise RequestError, "request unsuccessful: #{response.to_hash.inspect}"
+      options = {:query => query, :headers => self.class.headers.merge(authorization_header)}
+      if body
+        options[:headers]["Content-type"] = "application/json"
+        options[:body] = ActiveSupport::JSON.encode(body)
+      end
+
+      response = self.class.send method, path, options
+      case response.code
+      when 200, 201 then response.to_hash
+      else raise RequestError, "request unsuccessful: #{response.inspect}"
       end
     end
 
-    def request_headers
-      {"Authorization" => "OAuth #{access_token}", 'Accept' => 'application/json'}
+    def authorization_header
+      {
+        "Authorization" => "OAuth #{access_token}",
+      }
     end
   end
 end

data/lib/hashblue/contact.rb

@@ -9,5 +9,9 @@ module Hashblue
     def messages_uri
       @attributes["messages"]
     end
+
+    def send_message(content)
+      client.post messages_uri, {}, "message" => {"content" => content}
+    end
   end
 end

data/lib/hashblue/version.rb

@@ -1,3 +1,3 @@
 module Hashblue
-  VERSION = "0.0.2"
+  VERSION = "0.0.3"
 end

data/lib/hashblue.rb

@@ -1,5 +1,3 @@
-require "hashblue/version"
-
 module Hashblue
   autoload :Account, 'hashblue/account'
   autoload :Client, 'hashblue/client'

data/spec/models/account_spec.rb

@@ -8,10 +8,22 @@ describe Hashblue::Account do
   subject do
     Hashblue::Account.new(client, {
       'messages' => 'https://api.example.com/messages',
-      'contacts' => 'https://api.example.com/contacts'
+      'contacts' => 'https://api.example.com/contacts',
+      'favourite_messages' => 'https://api.example.com/messages/favourites'
     })
   end
 
+  describe '.authenticate' do
+    it "returns Account model built with response from GET /account" do
+      client.class.stubs(:new).with('access-token').returns(client)
+      attributes = {
+        "msisdn" => "4479001234567"
+      }
+      client.stubs(:get).with('/account').returns("account" => attributes)
+      Hashblue::Account.authenticate('access-token').should eql(Hashblue::Account.new(client, attributes))
+    end
+  end
+
   describe '#messages' do
     it "loads messages from its messages uri" do
       client.expects(:load_messages).with('https://api.example.com/messages', {}).returns([:some_messages])
@@ -25,4 +37,11 @@ describe Hashblue::Account do
       subject.contacts.should eql([:some_contacts])
     end
   end
+
+  describe '#favourite_messages' do
+    it "loads messages from its favourite messages uri" do
+      client.expects(:load_messages).with('https://api.example.com/messages/favourites', {}).returns([:some_messages])
+      subject.favourite_messages.should eql([:some_messages])
+    end
+  end
 end

data/spec/models/client_spec.rb

@@ -5,78 +5,44 @@ describe Hashblue::Client do
     Hashblue::Client.new('hashblue-access-token')
   end
 
+  describe 'all requests' do
+    it 'point to api.hashblue.com' do
+      Hashblue::Client.base_uri.should == 'https://api.hashblue.com'
+    end
+
+    it 'request json responses' do
+      Hashblue::Client.headers['Accept'].should == 'application/json'
+    end
+
+    it 'include a user-agent' do
+      Hashblue::Client.headers['User-Agent'].should_not be_nil
+    end
+  end
+
   describe '#get' do
     it "makes requests with Authorization and Accept headers and passed query" do
       Hashblue::Client.expects(:get).with("/messages",
-        :headers => {
-          "Authorization" => "OAuth hashblue-access-token",
-          "Accept" => "application/json"
-        },
+        :headers => Hashblue::Client.headers.merge({
+          "Authorization" => "OAuth hashblue-access-token"
+        }),
         :query => {
           :since => '2011-01-14T14:30Z'
         }
-      ).returns(mock(:headers => {"status" => "200"}, :to_hash => {}))
+      ).returns(mock(:code => 200, :to_hash => {}))
       subject.get "/messages", :since => '2011-01-14T14:30Z'
     end
 
-    it "raises RequestError if response status isn't 200" do
+    it "raises RequestError if response code isn't 200" do
       Hashblue::Client.expects(:get).with("/messages",
-        :headers => {
-          "Authorization" => "OAuth hashblue-access-token",
-          "Accept" => "application/json"
-        },
+        :headers => Hashblue::Client.headers.merge({
+          "Authorization" => "OAuth hashblue-access-token"
+        }),
         :query => {}
-      ).returns(mock(:headers => {"status" => "401"}, :to_hash => {}))
+      ).returns(mock(:code => 500, :inspect => ""))
       lambda {subject.get "/messages"}.should raise_error(Hashblue::Client::RequestError)
     end
   end
 
-  describe '#account' do
-    it "returns Account model built with response from GET /account" do
-      attributes = {
-        "msisdn" => "4479001234567"
-      }
-      subject.stubs(:get).returns("account" => attributes)
-      subject.account.should eql(Hashblue::Account.new(subject, attributes))
-    end
-  end
-
-  describe '#messages(query = {})' do
-    it "loads messages from '/messages'" do
-      subject.expects(:load_messages).with('/messages', {}).returns([:some_messages])
-      subject.messages.should eql([:some_messages])
-    end
-
-    it "passes query through to load_messages" do
-      subject.expects(:load_messages).with('/messages', {:anything => :here})
-      subject.messages(:anything => :here)
-    end
-  end
-
-  describe '#contacts(query = {})' do
-    it "loads contacts from '/contacts'" do
-      subject.expects(:load_contacts).with('/contacts', {}).returns([:some_contacts])
-      subject.contacts.should eql([:some_contacts])
-    end
-
-    it "passes query through to load_contacts" do
-      subject.expects(:load_contacts).with('/contacts', {:anything => :here})
-      subject.contacts(:anything => :here)
-    end
-  end
-
-  describe '#favourites(query = {})' do
-    it "loads messages from '/messages/favourites'" do
-      subject.expects(:load_messages).with('/messages/favourites', {}).returns([:favourite_messages])
-      subject.favourites.should eql([:favourite_messages])
-    end
-
-    it "passes query through to load_messages" do
-      subject.expects(:load_messages).with('/messages/favourites', {:anything => :here})
-      subject.favourites(:anything => :here)
-    end
-  end
-
   describe '#load_messages(uri, query)' do
     it "builds a Collection of messages with the response from the uri" do
       response = {"messages" => [{"content" => "hello"}]}

data/spec/models/contact_spec.rb

@@ -14,8 +14,15 @@ describe Hashblue::Contact do
 
   describe '#messages' do
     it "loads messages from its messages uri" do
-      client.expects(:load_messages).with('https://api.example.com/contact/1/messages', {}).returns([:some_messages])
+      client.expects(:load_messages).with(subject.messages_uri, {}).returns([:some_messages])
       subject.messages.should eql([:some_messages])
     end
   end
+
+  describe '#send_message(content)' do
+    it "posts message to messages_uri" do
+      client.expects(:post).with(subject.messages_uri, {}, {"message" => {"content" => "Hello!"}})
+      subject.send_message "Hello!"
+    end
+  end
 end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: hashblue
 version: !ruby/object:Gem::Version 
-  hash: 27
+  hash: 25
   prerelease: 
   segments: 
   - 0
   - 0
-  - 2
-  version: 0.0.2
+  - 3
+  version: 0.0.3
 platform: ruby
 authors: 
 - Tom Ward
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-06-21 00:00:00 Z
+date: 2011-06-24 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   type: :runtime
@@ -34,8 +34,23 @@ dependencies:
   name: httparty
   prerelease: false
 - !ruby/object:Gem::Dependency 
-  type: :development
+  type: :runtime
   requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 7
+        segments: 
+        - 3
+        - 0
+        version: "3.0"
+  version_requirements: *id002
+  name: activesupport
+  prerelease: false
+- !ruby/object:Gem::Dependency 
+  type: :development
+  requirement: &id003 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
@@ -46,12 +61,12 @@ dependencies:
         - 9
         - 2
         version: 0.9.2
-  version_requirements: *id002
+  version_requirements: *id003
   name: rake
   prerelease: false
 - !ruby/object:Gem::Dependency 
   type: :development
-  requirement: &id003 !ruby/object:Gem::Requirement 
+  requirement: &id004 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
@@ -62,12 +77,12 @@ dependencies:
         - 6
         - 0
         version: 2.6.0
-  version_requirements: *id003
+  version_requirements: *id004
   name: rspec
   prerelease: false
 - !ruby/object:Gem::Dependency 
   type: :development
-  requirement: &id004 !ruby/object:Gem::Requirement 
+  requirement: &id005 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
@@ -76,7 +91,7 @@ dependencies:
         segments: 
         - 0
         version: "0"
-  version_requirements: *id004
+  version_requirements: *id005
   name: mocha
   prerelease: false
 description: A simple client for the hashblue api