hashblue-api 0.0.8

data/test/test_helper.rb

@@ -0,0 +1,32 @@
+# This isn't great
+
+begin
+  # Require the preresolved locked set of gems.
+  require File.expand_path('../../../.bundle/environment', __FILE__)
+rescue LoadError
+  # Fallback on doing the resolve at runtime.
+  require "rubygems"
+  require "bundler"
+  Bundler.setup
+end
+
+require 'test/unit'
+require 'mocha'
+require 'shoulda'
+require 'webmock/test_unit'
+
+# This dependency needs to be removed
+
+require 'hashblue/api'
+
+Hashblue::API.base_uri "http://www.example.com"
+Hashblue::API.timeout 1
+
+class Test::Unit::TestCase
+  def dont_respond_to_http_requests_for_10_seconds
+    stub_request(:any, Regexp.new(Regexp.escape("http://www.example.com/"))).to_return(lambda {|request|
+      sleep(10)
+      result = {:headers => {}, :body => {}, :status => 200 }
+    })
+  end
+end

data/test/unit/api_test.rb

@@ -0,0 +1,17 @@
+require File.expand_path('../../test_helper', __FILE__)
+
+class Hashblue::APITest < Test::Unit::TestCase
+  include WebMock
+  
+  context "Hashblue::API" do
+    context "a request that times out" do
+      setup do
+        dont_respond_to_http_requests_for_10_seconds
+      end
+      
+      should "raise a TimeoutError" do
+        assert_raises(Hashblue::API::NotRespondingError) { Hashblue::API.get '/any/path' }
+      end
+    end
+  end
+end

data/test/unit/contact_test.rb

@@ -0,0 +1,27 @@
+require File.expand_path('../../test_helper', __FILE__)
+
+class Hashblue::API::ContactTest < Test::Unit::TestCase
+  context "Hashblue::API::Contact" do
+    should "return Contact for model name" do
+      assert_equal 'Contact', Hashblue::API::Contact.model_name
+    end
+
+    should "return contact for model_name.singular" do
+      assert_equal 'contact', Hashblue::API::Contact.model_name.singular
+    end
+  end
+  
+  context "A contact initialized with an subscriber_id and an id" do
+    setup do
+      @subscriber_id = 'ffddee554433'
+      @id = 'abcdef123456'
+      @contact = Hashblue::API::Contact.new(:id => @id, :subscriber_id => @subscriber_id)
+    end
+    
+    should "return messages found at /subscribers/:subscriber_id/contacts/:id/messages.json as messages" do
+      Hashblue::API.expects(:get).with("/subscribers/#{@subscriber_id}/contacts/#{@id}/messages.json", anything).returns(@json = :messages_json)
+      Hashblue::API::Message.expects(:from_json).with(@json).returns(:messages)
+      assert_equal :messages, @contact.messages
+    end    
+  end
+end

data/test/unit/message_api_test.rb

@@ -0,0 +1,135 @@
+require File.expand_path('../../test_helper', __FILE__)
+
+class Hashblue::API::MessageAPITest < Test::Unit::TestCase
+  # include WebMock
+  #
+  # context "When loading a messages for an MSISDN" do
+  #   context "and the API responds with a message" do
+  #     setup do
+  #       stub_request(:get, Hashblue::API.url_for("/subscribers/44123456789/messages.json")).to_return(
+  #         :body => %{[{"sender":"44123456789","content":"Hello","recipient":"44987654321","timestamp":"2010/02/15 17:26:21 +0000"}]},
+  #         :status => 200,
+  #         :headers => {'Content-Type' => Mime::JSON.to_s}
+  #       )
+  #       @messages = Hashblue::API::Message.messages_for("44123456789")
+  #       @message = @messages.first
+  #     end
+  #
+  #     should "return an instantiated Hashblue::API::Message" do
+  #       assert_equal 1, @messages.length
+  #     end
+  #
+  #     should "parse the message content" do
+  #       assert_equal "Hello", @message.content
+  #     end
+  #
+  #     should "parse the message sender MSISDN" do
+  #       assert_equal "44123456789", @message.sender_msisdn
+  #     end
+  #
+  #     should "parse the message recipient MSISDN" do
+  #       assert_equal "44987654321", @message.recipient_msisdn
+  #     end
+  #
+  #     should "parse the timestamp" do
+  #       assert_equal Time.parse("2010/02/15 17:26:21 +0000"), @message.timestamp
+  #     end
+  #   end
+  #
+  #   context "and the API responds with several messages" do
+  #     setup do
+  #       stub_request(:get, Hashblue::API.url_for("/subscribers/44123456789/messages.json")).to_return(
+  #         :body => %{[{"sender":"44123456789","content":"Hello","recipient":"44987654321","timestamp":"2010/02/15 17:26:21 +0000"},{"sender":"44234567890","content":"Goodbye","recipient":"44987654321","timestamp":"2010/02/15 17:36:41 +0000"}]},
+  #         :status => 200,
+  #         :headers => {'Content-Type' => Mime::JSON.to_s}
+  #       )
+  #       @messages = Hashblue::API::Message.messages_for("44123456789")
+  #     end
+  #
+  #     should "return each message" do
+  #       assert_equal 2, @messages.length
+  #     end
+  #
+  #     should "parse all content" do
+  #       assert_equal %w(Hello Goodbye), @messages.map(&:content)
+  #     end
+  #   end
+  #
+  #   context "and the API has no messages for that MSISDN" do
+  #     setup do
+  #       stub_request(:get, Hashblue::API.url_for("/subscribers/44123456789/messages.json")).to_return(
+  #         :body => %{[]},
+  #         :status => 200,
+  #         :headers => {'Content-Type' => Mime::JSON.to_s}
+  #       )
+  #       @messages = Hashblue::API::Message.messages_for("44123456789")
+  #     end
+  #
+  #     should "return an empty array" do
+  #       assert @messages.empty?
+  #     end
+  #   end
+  #
+  #   context "and the API responds with something that isn't JSON" do
+  #     setup do
+  #       stub_request(:get, Hashblue::API.url_for("/subscribers/44123456789/messages.json")).to_return(
+  #         :body => %{<html><body><h1>Oh hello, this is HTML, yes.</body></html>},
+  #         :status => 200,
+  #         :headers => {'Content-Type' => Mime::HTML.to_s}
+  #       )
+  #     end
+  #
+  #     should "raise an exception" do
+  #       assert_raises(Hashblue::API::BadResponseError) do
+  #         Hashblue::API::Message.messages_for("44123456789")
+  #       end
+  #     end
+  #   end
+  #
+  #   context "and the API responds with a 500 status code" do
+  #     setup do
+  #       stub_request(:get, Hashblue::API.url_for("/subscribers/44123456789/messages.json")).to_return(
+  #         :body => %{[]},
+  #         :status => 500,
+  #         :headers => {'Content-Type' => Mime::JSON.to_s}
+  #       )
+  #     end
+  #
+  #     should "raise an exception" do
+  #       assert_raises(Hashblue::API::BadResponseError) do
+  #         Hashblue::API::Message.messages_for("44123456789")
+  #       end
+  #     end
+  #   end
+  #
+  #   context "and the API fails to respond within 2 seconds" do
+  #     setup do
+  #       dont_respond_to_http_requests_for_10_seconds
+  #     end
+  #
+  #     should "raise a NotRespondingError" do
+  #       assert_raises(Hashblue::API::NotRespondingError) do
+  #         Hashblue::API::Message.messages_for("44123456789")
+  #       end
+  #     end
+  #   end
+  # end
+  #
+  # context "Deleting an individual message" do
+  #   context "when the api fails to respond" do
+  #     setup do
+  #       dont_respond_to_http_requests_for_10_seconds
+  #     end
+  #
+  #     should "raise a NotRespondingError" do
+  #       assert_raises(Hashblue::API::NotRespondingError) do
+  #         Hashblue::API::Message.delete("1234567", "ab44ff33")
+  #       end
+  #     end
+  #   end
+  # end
+
+  # authentication?
+  # pagination?
+
+end

data/test/unit/message_test.rb

@@ -0,0 +1,42 @@
+require File.expand_path('../../test_helper', __FILE__)
+
+class Hashblue::API::MessageTest < Test::Unit::TestCase
+  context "Hashblue::API::Message" do
+    should "return Message for model name" do
+      assert_equal 'Message', Hashblue::API::Message.model_name
+    end
+
+    should "return message for model_name.singular" do
+      assert_equal 'message', Hashblue::API::Message.model_name.singular
+    end
+  end
+
+  context "A message initialized with attributes from the API" do
+    setup do
+      @attributes = {
+        :id => '12345678',
+        :subscriber_id => 'djash12kv2',
+        :timestamp => '2010-03-18T15:03:58Z',
+        :sent => true
+      }
+      @message = Hashblue::API::Message.new(@attributes)
+    end
+    
+    should "return timestamp as ruby Time object" do
+      assert_equal Time.utc(2010, 03, 18, 15, 03, 58), @message.timestamp
+    end
+
+    should "be sent if sent is true" do
+      assert @message.sent?
+    end
+
+    should "not be received when sent is true" do
+      assert !@message.received?
+    end
+
+    should "delete the message by calling the API" do
+      Hashblue::API.expects(:delete).with("/subscribers/djash12kv2/messages/12345678.json", anything)
+      @message.delete
+    end
+  end
+end

data/test/unit/model_test.rb

@@ -0,0 +1,27 @@
+require File.expand_path('../../test_helper', __FILE__)
+
+class Hashblue::API::ModelTest < Test::Unit::TestCase
+  context "Hashblue API models in general" do
+    setup do
+      @attributes = {
+        :id => '12345678',
+        :subscriber_id => 'djash12kv2',
+        :anything => 'something'
+      }
+      @message = Hashblue::API::Model.new(@attributes)
+    end
+    
+    should "return passed in id as id" do
+      assert_equal @attributes[:id], @message.id
+    end
+    
+    should "return other passed in attributes when accessed through methods" do
+      assert_equal @attributes[:subscriber_id], @message.subscriber_id
+      assert_equal @attributes[:anything], @message.anything
+    end
+
+    should "return id when to_param called" do
+      assert_equal @message.id, @message.to_param
+    end
+  end
+end

data/test/unit/subscriber_test.rb

@@ -0,0 +1,42 @@
+require File.expand_path('../../test_helper', __FILE__)
+
+class Hashblue::API::SubscriberTest < Test::Unit::TestCase
+  context "Hashblue::API::Subscriber" do
+    should "return Subscriber for model name" do
+      assert_equal 'Subscriber', Hashblue::API::Subscriber.model_name
+    end
+
+    should "return subscriber for model_name.singular" do
+      assert_equal 'subscriber', Hashblue::API::Subscriber.model_name.singular
+    end
+  end
+
+  context "A subscriber found with an id" do
+    setup do
+      @id = 'abcdef123456'
+      @subscriber = Hashblue::API::Subscriber.find(@id)
+    end
+
+    should "have same id as found with" do
+      assert_equal @id, @subscriber.id
+    end
+
+    should "return messages found at /subscribers/:id/messages.json as messages" do
+      Hashblue::API.expects(:get).with("/subscribers/#{@id}/messages.json", anything).returns(@json = :messages_json)
+      Hashblue::API::Message.expects(:from_json).with(@json).returns(:messages)
+      assert_equal :messages, @subscriber.messages
+    end
+
+    should "return deleted messages found at /subscribers/:id/messages/deleted.json as deleted_messages" do
+      Hashblue::API.expects(:get).with("/subscribers/#{@id}/messages/deleted.json", anything).returns(@json = :messages_json)
+      Hashblue::API::Message.expects(:from_json).with(@json).returns(:messages)
+      assert_equal :messages, @subscriber.deleted_messages
+    end
+
+    should "return contacts found at /subscribers/:id/contacts.json as contacts" do
+      Hashblue::API.expects(:get).with("/subscribers/#{@id}/contacts.json", anything).returns(@json = :contacts_json)
+      Hashblue::API::Contact.expects(:from_json).with(@json).returns(:contacts)
+      assert_equal :contacts, @subscriber.contacts
+    end
+  end
+end

metadata

@@ -0,0 +1,110 @@
+--- !ruby/object:Gem::Specification 
+name: hashblue-api
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 0
+  - 8
+  version: 0.0.8
+platform: ruby
+authors: 
+- FreeRange
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-05-07 00:00:00 +01:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: httparty
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - "="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        - 5
+        - 2
+        version: 0.5.2
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: activesupport
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 2
+        - 3
+        - 5
+        version: 2.3.5
+  type: :runtime
+  version_requirements: *id002
+description: 
+email: lets@gofreerange.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README
+files: 
+- README
+- Rakefile
+- hashblue-api.gemspec
+- lib/dependency/mime_type.rb
+- lib/dependency/mime_types.rb
+- lib/hashblue/api.rb
+- lib/hashblue/api/contact.rb
+- lib/hashblue/api/error.rb
+- lib/hashblue/api/message.rb
+- lib/hashblue/api/model.rb
+- lib/hashblue/api/request.rb
+- lib/hashblue/api/subscriber.rb
+- lib/hashblue/api/test_helper.rb
+- test/helpers/test_helper_test.rb
+- test/test_helper.rb
+- test/unit/api_test.rb
+- test/unit/contact_test.rb
+- test/unit/message_api_test.rb
+- test/unit/message_test.rb
+- test/unit/model_test.rb
+- test/unit/subscriber_test.rb
+has_rdoc: true
+homepage: http://gofreerange.com
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --main
+- README
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.6
+signing_key: 
+specification_version: 3
+summary: It's the Hashblue API, stupid!
+test_files: []
+