tam 1.1.1 → 1.2.0

data/.gitignore

@@ -1,3 +1,4 @@
 pkg
 Gemfile.lock
+coverage
 

data/README.mkd

@@ -56,3 +56,11 @@ If you are using rails then:
 	  
 	end
 ```	
+
+5. The routes exposed by the gem in your rails application are:
+
+```ruby
+	/tamapi/authorize
+	/tamapi/receive_sms		# use this one (complement to form absolute path) as SMS URL when registering your application in telcoassetmarketplace.com
+	/tamapi/oauth_callback  # use this one (complement to form absolute path) as OAUTH callback URL when registering your application in telcoassetmarketplace.com
+```

data/Rakefile

@@ -28,4 +28,13 @@ end
 desc "Clean automatically generated files"
 task :clean do
   FileUtils.rm_rf "pkg"
-end
+end
+
+require 'spec/rake/spectask'
+
+Spec::Rake::SpecTask.new(:spec) do |t|
+  t.spec_files = Dir.glob('spec/**/*_spec.rb')
+end
+
+desc "Run tests"
+task :default => :spec

data/lib/tam/api/sms.rb

@@ -22,8 +22,10 @@ module TAM
       from_user = User.new(access_token, token_secret)
       to_app = data["to"]
       body = data["body"]
+      transaction_id = data["transaction_id"]
+
       begin
-        dispatch_to_handler('receive_sms', from_user, to_app, body)
+        dispatch_to_handler('receive_sms', from_user, to_app, body, transaction_id)
         response.status = 200
         return ''
       rescue Error => error
@@ -33,9 +35,13 @@ module TAM
     end
     
     # Sends an SMS
-    def self.send_sms(from_app, to_user, body)
-      payload = JSON.generate({'body' => body, 'from' => from_app})
-      dispatch_to_tam(:post, '/api/1/sms/send', to_user, payload)
+    def self.send_sms(from_app, to_user, body, transaction_id = nil)
+      payload = {'body' => body, 'from' => from_app}
+      if transaction_id
+        payload["transaction_id"] = transaction_id
+      end
+      response = dispatch_to_tam(:post, '/api/1/sms/send', to_user, JSON.generate(payload))
+      JSON.parse response
     end
   end
 end

data/lib/tam/user.rb

@@ -8,5 +8,9 @@ module TAM
       @access_token = access_token
       @token_secret = token_secret
     end
+    
+    def ==(another_user)
+        self.access_token == another_user.access_token and self.token_secret == another_user.token_secret
+    end
   end
 end

data/lib/tam/version.rb

@@ -1,4 +1,4 @@
 module TAM
   # The version of the gem
-  VERSION = '1.1.1'.freeze unless defined?(::TAM::VERSION)
+  VERSION = '1.2.0'.freeze unless defined?(::TAM::VERSION)
 end

data/spec/fixtures/tam_getcoord_success.json

@@ -0,0 +1,11 @@
+{
+  "status": {
+    "code":0,
+    "message":"Message sent successfully"
+	}, "body": {
+		"latitude":10.0,
+    	"longitude":-20.0, 
+    	"accuracy":10, 
+    	"timestamp":1288747339000
+ 	}
+}

data/spec/fixtures/tam_send_sms_success.json

@@ -0,0 +1,6 @@
+{
+  "status": {
+    "code":0,
+    "message":"Message sent successfully"
+  }
+}

data/spec/location_get_spec.rb

@@ -0,0 +1,46 @@
+require 'spec_helper'
+require 'tam/api'
+require 'tam/user'
+require 'rack/test'
+require 'json'
+require 'webmock/rspec'
+
+describe TAM::API, "#getcoord" do
+  include WebMock::API
+  include OAuthSettings
+  
+  it "sends location request to platform" do
+    #given
+    TAM.expects(:consumer_key).twice().returns(ConsumerKey)
+    TAM.expects(:consumer_secret).twice().returns(ConsumerSecret)
+    TAM.expects(:site).returns(Site)
+    TAM.expects(:request_token_path).returns('/api/1/oauth/request_token')
+    TAM.expects(:access_token_path).returns('/api/1/oauth/access_token')
+    TAM.expects(:authorize_path).returns('/web/authorize')
+    TAM.expects(:oauth_scheme).returns(:query_string)
+    TAM.expects(:oauth_http_method).returns(:get)
+    http_stub = stub_request(:get, /.*\/api\/1\/location\/getcoord.*/).with { |request| assert_query(request.uri, OAuthParams) }.to_return(:body => load_fixture("tam_getcoord_success.json"))
+                  
+    #when
+    body = TAM::API.getcoord(TAM::User.new(AccessToken, AccessSecret))
+    
+    #then
+    http_stub.should have_been_requested.times(1)
+    body["status"]["code"].should == 0
+    body["status"]["message"].should == "Message sent successfully"
+  end
+    
+  def load_fixture(fixture)
+    IO.read("spec/fixtures/#{fixture}")
+  end
+  
+  def assert_query(uri, params)
+    uri_params = uri.query_values
+    params.each do |key, value| 
+      if not value.match(uri_params[key])
+        return false
+      end
+    end
+    return true
+  end
+end

data/spec/sms_receive_spec.rb

@@ -0,0 +1,68 @@
+require 'spec_helper'
+require 'tam/api'
+require 'tam/user'
+require 'rack/test'
+require 'mocha'
+require 'json'
+
+describe TAM::API, "when receiving sms" do
+  include Rack::Test::Methods
+
+  def app
+    TAM::API
+  end
+  
+  before(:all) do
+    logger = stub('logger')
+    logger.stubs(:error)
+    TAM.const_set(:LOGGER, logger)
+  end
+  
+  it "should pass request to tam sms handler and render success" do
+    #given
+    handler = stub('consumer_handler')
+    handler.expects(:respond_to?).with('receive_sms').returns(true)
+    handler.expects(:send).with('receive_sms', TAM::User.new('token', 'secret'), 'to_app', 'message', nil)
+    TAM.expects(:consumer_handler).times(3).returns(handler)
+    #when
+    post '/tamapi/receive_sms', JSON.generate({ 'body' => 'message', 'to' => 'to_app', 'from' => 'from_user' ,'access_token' => 'token', 'token_secret' => 'secret'})
+    #then
+    last_response.should be_ok
+  end
+  
+  it "shpuld pass request with transaction to tam sms handler and render success" do
+    #given
+    handler = stub('consumer_handler')
+    handler.expects(:respond_to?).with('receive_sms').returns(true)
+    handler.expects(:send).with('receive_sms', TAM::User.new('token', 'secret'), 'to_app', 'message', 'tran_id')
+    TAM.expects(:consumer_handler).times(3).returns(handler)
+    #when
+    post '/tamapi/receive_sms', JSON.generate({ 'body' => 'message', 'to' => 'to_app', 'from' => 'from_user','transaction_id' => 'tran_id','access_token' => 'token', 'token_secret' => 'secret'})
+    #then
+    last_response.should be_ok
+  end
+  
+  it "should pass request to tam sms handler and render error on unexpected error" do
+    #given
+    handler = stub('consumer_handler')
+    handler.expects(:respond_to?).with('receive_sms').returns(true)
+    handler.stubs(:send).raises(TAM::UnexpectedError.new("Cannot handle"))
+    TAM.expects(:consumer_handler).times(3).returns(handler)
+    #when
+    post '/tamapi/receive_sms', JSON.generate({ 'body' => 'message', 'to' => 'to_app', 'from' => 'from_user','transaction_id' => 'tran_id','access_token' => 'token', 'token_secret' => 'secret'})
+    #then
+    last_response.should be_server_error
+    last_response.body.should == "Cannot handle"
+  end
+  
+  it "should pass request to tam sms handler and render error on missing consumer_handler" do
+    #given
+    handler = stub('consumer_handler')
+    TAM.expects(:consumer_handler).times(1).returns(nil)
+    #when
+    post '/tamapi/receive_sms', JSON.generate({ 'body' => 'message', 'to' => 'to_app', 'from' => 'from_user','transaction_id' => 'tran_id','access_token' => 'token', 'token_secret' => 'secret'})
+    #then
+    last_response.should be_server_error
+    last_response.body.should == "Application has not configured the telco asset marketplace consumer_handler"
+  end
+end

data/spec/sms_send_spec.rb

@@ -0,0 +1,71 @@
+require 'spec_helper'
+require 'tam/api'
+require 'tam/user'
+require 'rack/test'
+require 'json'
+require 'webmock/rspec'
+
+describe TAM::API, "when sending sms" do
+  include WebMock::API
+  include OAuthSettings
+  
+  it "should succelfully send the request to platform" do
+    #given
+    TAM.expects(:consumer_key).twice().returns(ConsumerKey)
+    TAM.expects(:consumer_secret).twice().returns(ConsumerSecret)
+    TAM.expects(:site).returns(Site)
+    TAM.expects(:request_token_path).returns('/api/1/oauth/request_token')
+    TAM.expects(:access_token_path).returns('/api/1/oauth/access_token')
+    TAM.expects(:authorize_path).returns('/web/authorize')
+    TAM.expects(:oauth_scheme).returns(:query_string)
+    TAM.expects(:oauth_http_method).returns(:get)
+    http_stub = stub_request(:post, /.*\/api\/1\/sms\/send.*/).with { |request|  assert_request(request, { :query => OAuthParams, :body => "{\"body\":\"test message\",\"from\":\"to_app\"}"})}.to_return(:body => load_fixture("tam_send_sms_success.json"))
+                  
+    #when
+    body = TAM::API.send_sms("to_app", TAM::User.new(AccessToken,  AccessSecret), 'test message')
+    
+    #then
+    http_stub.should have_been_requested.times(1)
+    body["status"]["code"].should == 0
+    body["status"]["message"].should == "Message sent successfully"
+  end
+  
+  it "sends sms request with transaction id to platform" do
+    #given
+    TAM.expects(:consumer_key).twice().returns(ConsumerKey)
+    TAM.expects(:consumer_secret).twice().returns(ConsumerSecret)
+    TAM.expects(:site).returns(Site)
+    TAM.expects(:request_token_path).returns('/api/1/oauth/request_token')
+    TAM.expects(:access_token_path).returns('/api/1/oauth/access_token')
+    TAM.expects(:authorize_path).returns('/web/authorize')
+    TAM.expects(:oauth_scheme).returns(:query_string)
+    TAM.expects(:oauth_http_method).returns(:get)
+    http_stub = stub_request(:post, /.*\/api\/1\/sms\/send.*/).with { |request| assert_request(request, { :query => OAuthParams, :body => "{\"body\":\"test message\",\"from\":\"to_app\",\"transaction_id\":\"tran_id\"}"})}.to_return(:body => load_fixture("tam_send_sms_success.json"))
+                  
+    #when
+    body = TAM::API.send_sms("to_app", TAM::User.new(AccessToken,  AccessSecret), 'test message', 'tran_id')
+    
+    #then
+    http_stub.should have_been_requested.times(1)
+    body["status"]["code"].should == 0
+    body["status"]["message"].should == "Message sent successfully"
+  end
+  
+  def load_fixture(fixture)
+    IO.read("spec/fixtures/#{fixture}")
+  end
+  
+  def assert_request(req, matchers)
+    return (assert_query(req.uri, matchers[:query]) and req.body == matchers[:body])
+  end
+  
+  def assert_query(uri, params)
+    uri_params = uri.query_values
+    params.each do |key, value| 
+      if not value.match(uri_params[key])
+        return false
+      end
+    end
+    return true
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,14 @@
+require 'simplecov'
+SimpleCov.start do
+  add_filter "/spec/"
+end
+
+module OAuthSettings
+  AccessToken = "token"
+  AccessSecret = "secret"
+  ConsumerKey = "consumer_key"
+  ConsumerSecret = "consumer_secret"
+  Site = "https://telcoassetmarketplace.com"
+  
+  OAuthParams = {"oauth_consumer_key" => /^#{ConsumerKey}$/, "oauth_signature_method" => /^HMAC-SHA1$/, "oauth_nonce" => /.+/,  "oauth_signature" => /.+/, "oauth_timestamp" => /^[0-9]+$/, "oauth_version" => /^1.0$/, "oauth_token" => /^#{AccessToken}$/}
+end

data/tam.gemspec

@@ -6,6 +6,13 @@ Gem::Specification.new do |s|
   s.add_runtime_dependency('json', '~> 1.5')
   s.add_runtime_dependency('oauth', '~> 0.4.3')
   
+  s.add_development_dependency('rake', '= 0.9.2')
+  s.add_development_dependency('rspec', '= 1.3.2')
+  s.add_development_dependency('rack-test', "~> 0.6.1")
+  s.add_development_dependency('mocha', '~> 0.9.0')
+  s.add_development_dependency('webmock', '~> 1.7.0')
+  s.add_development_dependency('simplecov', '~> 0.5.0')
+    
   s.name = "tam"
   s.version = TAM::VERSION.dup
   s.platform = Gem::Platform::RUBY

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: tam
 version: !ruby/object:Gem::Version 
-  hash: 17
+  hash: 31
   prerelease: false
   segments: 
   - 1
-  - 1
-  - 1
-  version: 1.1.1
+  - 2
+  - 0
+  version: 1.2.0
 platform: ruby
 authors: 
 - Carlos Manzanares
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-06-08 00:00:00 +03:00
+date: 2011-10-19 00:00:00 +03:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -65,6 +65,102 @@ dependencies:
         - 3
         version: 0.4.3
   requirement: *id003
+- !ruby/object:Gem::Dependency 
+  name: rake
+  type: :development
+  prerelease: false
+  version_requirements: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - "="
+      - !ruby/object:Gem::Version 
+        hash: 63
+        segments: 
+        - 0
+        - 9
+        - 2
+        version: 0.9.2
+  requirement: *id004
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  type: :development
+  prerelease: false
+  version_requirements: &id005 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - "="
+      - !ruby/object:Gem::Version 
+        hash: 31
+        segments: 
+        - 1
+        - 3
+        - 2
+        version: 1.3.2
+  requirement: *id005
+- !ruby/object:Gem::Dependency 
+  name: rack-test
+  type: :development
+  prerelease: false
+  version_requirements: &id006 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 5
+        segments: 
+        - 0
+        - 6
+        - 1
+        version: 0.6.1
+  requirement: *id006
+- !ruby/object:Gem::Dependency 
+  name: mocha
+  type: :development
+  prerelease: false
+  version_requirements: &id007 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 59
+        segments: 
+        - 0
+        - 9
+        - 0
+        version: 0.9.0
+  requirement: *id007
+- !ruby/object:Gem::Dependency 
+  name: webmock
+  type: :development
+  prerelease: false
+  version_requirements: &id008 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 11
+        segments: 
+        - 1
+        - 7
+        - 0
+        version: 1.7.0
+  requirement: *id008
+- !ruby/object:Gem::Dependency 
+  name: simplecov
+  type: :development
+  prerelease: false
+  version_requirements: &id009 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 11
+        segments: 
+        - 0
+        - 5
+        - 0
+        version: 0.5.0
+  requirement: *id009
 description: The Ruby gem for the telco asset marketplace REST APIs
 email: 
 - developers@telcoassetmarketplace.com
@@ -91,6 +187,12 @@ files:
 - lib/tam/railtie.rb
 - lib/tam/user.rb
 - lib/tam/version.rb
+- spec/fixtures/tam_getcoord_success.json
+- spec/fixtures/tam_send_sms_success.json
+- spec/location_get_spec.rb
+- spec/sms_receive_spec.rb
+- spec/sms_send_spec.rb
+- spec/spec_helper.rb
 - tam.gemspec
 has_rdoc: true
 homepage: https://github.com/tamdeveloper/telco-asset-marketplace-gem
@@ -139,5 +241,10 @@ rubygems_version: 1.3.7
 signing_key: 
 specification_version: 3
 summary: telco asset marketplace Ruby gem
-test_files: []
-
+test_files: 
+- spec/fixtures/tam_getcoord_success.json
+- spec/fixtures/tam_send_sms_success.json
+- spec/location_get_spec.rb
+- spec/sms_receive_spec.rb
+- spec/sms_send_spec.rb
+- spec/spec_helper.rb