globe_labs 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 55859d8078c4e07000654daa1208f527f429ef8c
+  data.tar.gz: ce4c70b01684d27ba9c0c0b955a131e7c2433da2
+SHA512:
+  metadata.gz: ccb8147e289d1939d9fdc27081dbc983a3ed156d4140c3cd4a8fd75b788c3e294c0d586fc419d52177ff1708401326f8220505ae9814931fc98310ab67ded409
+  data.tar.gz: 81ac64af6977f6ba7fc52983506fbe93e67da7c1d2a97036d81a99e6f6d8f83bc741eae59b7b452ad8cad42f5a0df7abff2a453114b87a886ed56e0a9e4aa910

data/LICENSE.txt

@@ -0,0 +1,24 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Nexmo Inc
+
+Permission is hereby granted, free of charge, to any person
+obtaining a copy of this software and associated documentation
+files (the "Software"), to deal in the Software without
+restriction, including without limitation the rights to use,
+copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the
+Software is furnished to do so, subject to the following
+conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
+OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
+HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
+WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
+FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
+OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,144 @@
+# globelabs
+Ruby wrapper for [GlobeLabs](http://www.globelabs.com.ph/) API
+
+
+Add to Gemfile
+```ruby
+gem 'globelabs'
+```
+then
+
+	$ bundle install
+
+or
+
+	$ gem install globelabs
+
+
+## Usage
+#### Initialize
+```ruby
+require 'globelabs'
+
+globelabs = GlobeLabs::Client.new(key: 'app_id', secret: 'app_secret', send_address: 'short_code')
+```
+
+#### [Get Access Token](http://www.globelabs.com.ph/docs/#getting-started-opt-in-via-webform)
+_note: skip this part if you already have the access token_
+
+```ruby
+globelabs.get_access_token(code)
+
+# =>
+#  {
+#    "access_token":"1ixLbltjWkzwqLMXT-8UF-UQeKRma0hOOWFA6o91oXw",
+#    "subscriber_number":"9171234567"
+#  }
+```
+
+#### [Send Message](http://www.globelabs.com.ph/docs/#sms-sending-sms-sms-mt)
+Send an SMS message to one or more mobile terminals:
+```ruby
+globelabs.send_message(token, subscriber_number, message)
+
+# =>
+#  {
+#   "outboundSMSMessageRequest": {
+#     "address": "tel:+639175595283",
+#     "deliveryInfoList": {
+#       "deliveryInfo": [],
+#       "resourceURL": "https://devapi.globelabs.com.ph/smsmessaging/v1/outbound/8011/requests?access_token=3YM8xurK_IPdhvX4OUWXQljcHTIPgQDdTESLXDIes4g"
+#     },
+#     "senderAddress": "8011",
+#     "outboundSMSTextMessage": {
+#       "message": "Hello World"
+#     },
+#     "receiptRequest": {
+#       "notifyURL": "http://test-sms1.herokuapp.com/callback",
+#       "callbackData": null,
+#       "senderName": null,
+#       "resourceURL": "https://devapi.globelabs.com.ph/smsmessaging/v1/outbound/8011/requests?access_token=3YM8xurK_IPdhvX4OUWXQljcHTIPgQDdTESLXDIes4g"
+#     }
+#   }
+#  }
+```
+
+#### [Locate](http://www.globelabs.com.ph/docs/#location-based-services-resources-and-uris)
+Locate a subscriber’s location:
+```ruby
+globelabs.locate(token, subscriber_number)
+
+# =>
+#  {
+#    "terminalLocationList": {
+#      "terminalLocation": {
+#        "address": "tel:9171234567",
+#        "currentLocation": {
+#          "accuracy": 100,
+#          "latitude": "14.5609722",
+#          "longitude": "121.0193394",
+#          "map_url": "http://maps.google.com/maps?z=17&t=m&q=loc:14.5609722+121.0193394",
+#          "timestamp": "Fri Jun 06 2014 09:25:15 GMT+0000 (UTC)"
+#        },
+#        "locationRetrievalStatus": "Retrieved"
+#      }
+#    }
+#  }
+```
+
+#### [Charge](http://www.globelabs.com.ph/docs/#charging-charge-subscriber)
+Charge/bill a subscriber:
+```ruby
+options = {
+  amount: "20",
+  description: "sample description",
+  endUserId: "915xxxxxxx",
+  reference_code: '1234567',
+  transactionOperationStatus: 'Charged'
+}
+
+globelabs.charge(token, options)
+
+# =>
+#  {
+#   "amountTransaction":
+#   {
+#     "endUserId": "9171234567",
+#     "paymentAmount":
+#     {
+#       "chargingInformation":
+#       {
+#         "amount": "0.00",
+#         "currency": "PHP",
+#         "description": "my application"
+#       },
+#       "totalAmountCharged": "0.00"
+#     },
+#     "referenceCode": "12341000023",
+#     "serverReferenceCode": "528f5369b390e16a62000006",
+#     "resourceURL": null
+#    }
+#  }
+```
+
+#### [Last Reference Code](http://www.globelabs.com.ph/docs/#charging-get-last-reference-code)
+In case you lost of track of your reference code:
+```ruby
+globelabs.last_reference_code
+
+# =>
+# {
+#    "referenceCode": "12341000005",
+#    "status": "SUCCESS",
+#    "shortcode": "21581234"
+#  }
+```
+
+
+## Contributing
+
+1. Fork it ( https://github.com/jaemar/globelabs/fork )
+2. Create your feature branch (`git checkout -b feature/new_feature`)
+3. Commit your changes (`git commit -am 'Add new feature'`)
+4. Push to the branch (`git push origin feature/new_feature`)
+5. Create a new Pull Request

data/globe_labs.gemspec

@@ -0,0 +1,26 @@
+require File.expand_path('lib/globe_labs/version', File.dirname(__FILE__))
+
+Gem::Specification.new do |s|
+  s.name = 'globe_labs'
+  s.version = GlobeLabs::VERSION
+  s.license = 'MIT'
+  s.platform = Gem::Platform::RUBY
+  s.authors = ['Jaemar Ramos']
+  s.email = ['jaemar.ramos@gmail.com']
+  s.description = 'Globe Labs Client Library for Ruby'
+  s.summary = 'Ruby client library for Globe Labs\' API.'
+  s.required_ruby_version = '>= 1.9.3'
+
+  s.add_development_dependency('rake')
+  s.add_development_dependency('minitest', '~> 5.0')
+
+  if RUBY_VERSION == '1.9.3'
+    s.add_development_dependency('addressable', '< 2.5.0')
+    s.add_development_dependency('webmock', '~> 1.0')
+  else
+    s.add_development_dependency('webmock', '~> 2.0')
+  end
+
+  s.files = Dir.glob('{lib,spec}/**/*') + %w(LICENSE.txt README.md globe_labs.gemspec)
+  s.require_paths = ["lib"]
+end

data/lib/globe_labs.rb

@@ -0,0 +1,6 @@
+require 'globe_labs/version'
+require 'globe_labs/errors/error'
+require 'globe_labs/errors/client_error'
+require 'globe_labs/main'
+require 'globe_labs/params'
+require 'globe_labs/client'

data/lib/globe_labs/client.rb

@@ -0,0 +1,66 @@
+module GlobeLabs
+  class Client < Main
+    def send_message(token, number, message)
+      post(@api_host, send_sms_uri(token), build_send_message_params(number, message), 'json')
+    end
+
+    def locate(token, number)
+      get(@api_host, locate_uri, build_locate_params(token, number), 'json')
+    end
+
+    def charge(token, options = {})
+      post(@api_host, charge_uri(token), build_charge_params(options))
+    end
+
+    def last_reference_code
+      get(@api_host, reference_code_uri, {app_id: @key,
+                                           app_secret: @secret})
+    end
+
+    private
+    def send_sms_uri(token)
+      "/smsmessaging/#{@version}/outbound/#{@short_code}/requests?access_token=#{token}"
+    end
+
+    def build_send_message_params(number, message)
+      {
+        "outboundSMSMessageRequest": {
+          "clientCorrelator": "#{rand(10 ** 6)}",
+          "senderAddress": "#{@short_code}",
+          "outboundSMSTextMessage": {"message": "#{message}"},
+          "address": "tel:+63#{number}"
+        }
+      }
+    end
+
+    def locate_uri
+      "/location/#{@version}/queries/location"
+    end
+
+    def build_locate_params(token, number)
+      {
+        "access_token": token,
+        "address": "0#{number}",
+        "requestedAccuracy": "100"
+      }
+    end
+
+    def charge_uri(token)
+      "/payment/v1/transactions/amount?access_token=#{token}"
+    end
+
+    def build_charge_params(options)
+      {
+        amount: options[:amount],
+        description: options[:description],
+        endUserId: "tel:+63#{options[:endUserId]}",
+        referenceCode: "#{@short_code}#{options[:referenceCode]}",
+        transactionOperationStatus: 'Charged'
+      }
+    end
+
+    def reference_code_uri
+      '/payment/v1/transactions/getLastRefCode'
+    end
+  end
+end

data/lib/globe_labs/errors/authentication_error.rb

@@ -0,0 +1,4 @@
+module GlobeLabs
+  class AuthenticationError < Error
+  end
+end

data/lib/globe_labs/errors/client_error.rb

@@ -0,0 +1,4 @@
+module GlobeLabs
+  class ClientError < Error
+  end
+end

data/lib/globe_labs/errors/error.rb

@@ -0,0 +1,4 @@
+module GlobeLabs
+  class Error < StandardError
+  end
+end

data/lib/globe_labs/errors/server_error.rb

@@ -0,0 +1,4 @@
+module GlobeLabs
+  class ServerError < Error
+  end
+end

data/lib/globe_labs/main.rb

@@ -0,0 +1,84 @@
+require 'net/https'
+require 'net/http'
+require 'json'
+
+module GlobeLabs
+  class Main
+    attr_accessor :key, :secret, :access_token
+
+    def initialize(options = {})
+      @key = options.fetch(:key)
+      @secret = options.fetch(:secret)
+      @short_code = options[:sender_address]
+      @auth_host = options.fetch(:auth_host) { 'developer.globelabs.com.ph' }
+      @api_host = options.fetch(:api_host) { 'devapi.globelabs.com.ph' }
+      @version = options.fetch(:version) { 'v1' }
+    end
+
+    def get_access_token(code)
+      post(@auth_host, '/oauth/access_token', {app_id: @key,
+                                               app_secret: @secret,
+                                               code: code})
+    end
+
+    private
+    def get(host, request_uri, params = {}, content_type = 'x-www-form-urlencoded')
+      uri = URI('https://' + host + request_uri)
+      uri.query = Params.encode(params)
+
+      message = Net::HTTP::Get.new(uri.request_uri, 'Content-Type' => "application/#{content_type}")
+
+      case content_type
+      when 'json'
+        message.body = params.to_json
+      else
+        message.form_data = params
+      end
+
+      request(uri, message)
+    end
+
+    def post(host, request_uri, params, content_type = 'x-www-form-urlencoded')
+      uri = URI('https://' + host + request_uri)
+      message = Net::HTTP::Post.new(uri.request_uri, 'Content-Type' => "application/#{content_type}")
+
+      case content_type
+      when 'json'
+        message.body = params.to_json
+      else
+        message.form_data = params
+      end
+
+      request(uri, message)
+    end
+
+    def request(uri, message)
+      http = Net::HTTP.new(uri.host, Net::HTTP.https_default_port)
+      http.use_ssl = true
+
+      http_response = http.request(message)
+
+      case http_response
+      when Net::HTTPNoContent
+        :no_content
+      when Net::HTTPSuccess
+        return (yield http_response) if block_given?
+
+        if http_response['Content-Type'].split(';').first == 'application/json'
+          JSON.parse(http_response.body)
+        else
+          http_response.body
+        end
+      when Net::HTTPUnauthorized
+        raise AuthenticationError, "#{http_response.code} response from #{uri.host}"
+      when Net::HTTPClientError
+        http_response.body
+        #raise ClientError, "#{http_response.code} response from #{uri.host}"
+      when Net::HTTPServerError
+        raise ServerError, "#{http_response.code} response from #{uri.host}"
+      else
+        raise Error, "#{http_response.code} response from #{uri.host}"
+      end
+    end
+  end
+end

data/lib/globe_labs/params.rb

@@ -0,0 +1,14 @@
+require 'cgi'
+
+module GlobeLabs
+  module Params
+    def self.encode(params)
+      params.flat_map { |k, vs| Array(vs).map { |v| "#{escape(k)}=#{escape(v)}" } }.join('&')
+    end
+
+    private
+    def self.escape(component)
+      CGI.escape(component.to_s)
+    end
+  end
+end

data/lib/globe_labs/version.rb

@@ -0,0 +1,3 @@
+module GlobeLabs
+  VERSION = '0.0.1'
+end

data/spec/globe_labs/client_spec.rb

@@ -0,0 +1,158 @@
+require 'minitest/autorun'
+require 'webmock/minitest'
+require 'globe_labs'
+
+
+describe 'GlobeLabs::Client' do
+  before do
+    @key = 'key'
+    @secret = 'secret'
+    @short_code = '1234'
+    @token = 'token'
+    @number = '9951234567'
+    @message = 'your sample message'
+    @globe = GlobeLabs::Client.new(key: @key, secret: @secret, short_code: @short_code)
+    @api_host = 'https://devapi.globelabs.com.ph'
+    @response_body = {body: {key: 'value'}.to_json, headers: {'Content-Type' => 'application/json;charset=utf-8'}}
+    @response_object = {"key" => 'value'}
+  end
+
+  # TODO SEND MESSAGE
+  describe '#send_message' do
+    it 'returns response object' do
+      random = rand(10 ** 6)
+      body = {
+        "outboundSMSMessageRequest": {
+          "clientCorrelator": "#{random}",
+          "senderAddress": "#{@short_code}",
+          "outboundSMSTextMessage": {"message": "#{@message}"},
+          "address": "tel:+63#{@number}"
+        }
+      }
+      @globe.stub(:rand, random) do
+        stub_post("#@api_host/smsmessaging/v1/outbound/#@short_code/requests?access_token=#@token", body.to_json, 'json')
+        @globe.send_message(@token, @number, @message).must_equal @response_object
+      end
+    end
+  end
+
+  describe '#send_sms_uri' do
+    it 'returns send_sms_uri' do
+      @globe.send(:send_sms_uri, @token).must_equal '/smsmessaging/v1/outbound/1234/requests?access_token=token'
+    end
+  end
+
+  describe '#build_send_message_params' do
+    it 'returns build_send_message_params' do
+      response_object = {
+        outboundSMSMessageRequest: {
+          clientCorrelator: "123456",
+          senderAddress: "1234",
+          outboundSMSTextMessage: { message: "your sample message" },
+          address: "tel:+63#{@number}"
+        }
+      }
+
+      @globe.stub(:rand, 123456) do
+        @globe.send(:build_send_message_params, @number, @message).must_equal response_object
+      end
+    end
+  end
+
+  # LOCATE
+  describe '#locate' do
+    it 'fetch user current location' do
+      stub_get("#@api_host/location/v1/queries/location?access_token=#@token&address=0#@number&requestedAccuracy=100", 'json')
+      @globe.locate(@token, @number).must_equal @response_object
+    end
+  end
+
+  describe '#locate_uri' do
+    it 'returns locate_uri' do
+      @globe.send(:locate_uri).must_equal '/location/v1/queries/location'
+    end
+  end
+
+  describe '#build_locate_params' do
+    it 'returns build_locate_params' do
+      response_object = {
+        access_token: @token,
+        address: "0#{@number}",
+        requestedAccuracy: "100"
+      }
+      @globe.send(:build_locate_params, @token, @number).must_equal response_object
+    end
+  end
+
+  # CHARGE
+  describe '#charge' do
+    it 'returns response object' do
+      options = {
+        amount: "100",
+        description: 'sample description',
+        endUserId: "#{@number}",
+        referenceCode: "1234567",
+        transactionOperationStatus: 'Charged'
+      }
+
+      body = "amount=100&description=sample description&endUserId=tel:%2B63#@number&referenceCode=#{@short_code}1234567&transactionOperationStatus=Charged"
+
+      stub_post("#@api_host/payment/v1/transactions/amount?access_token=#@token", body)
+      @globe.charge(@token, options).must_equal @response_object
+    end
+  end
+
+  describe '#charge_uri' do
+    it 'returns charge_uri' do
+      @globe.send(:charge_uri, 'token').must_equal '/payment/v1/transactions/amount?access_token=token'
+    end
+  end
+
+  describe '#build_charge_params' do
+    it 'returns build_charge_params' do
+      params = {
+        amount: 100,
+        description: "description",
+        endUserId: @number,
+        referenceCode: "1234567",
+        transactionOperationStatus: 'Charged'
+      }
+
+      response_object = {
+        amount: 100,
+        description: "description",
+        endUserId: "tel:+63#{@number}",
+        referenceCode: "#{@short_code}1234567",
+        transactionOperationStatus: 'Charged'
+      }
+
+      @globe.send(:build_charge_params, params).must_equal response_object
+    end
+  end
+
+  # REFERENCE_CODE
+  describe '#last_reference_code' do
+    it 'fetch last reference code (charge)' do
+      stub_get("#@api_host/payment/v1/transactions/getLastRefCode?app_id=#@key&app_secret=#@secret")
+      @globe.last_reference_code.must_equal @response_object
+    end
+
+  end
+  describe '#reference_code_uri' do
+    it 'returns reference_code_uri' do
+      @globe.send(:reference_code_uri).must_equal '/payment/v1/transactions/getLastRefCode'
+    end
+  end
+
+  private
+  def stub_get(url, content_type = 'x-www-form-urlencoded')
+    headers = {'Content_type' => "application/#{content_type}"}
+    @request = stub_request(:get, url).with(headers: headers).to_return(@response_body)
+  end
+
+  def stub_post(url, body, content_type = 'x-www-form-urlencoded')
+    headers = {'Content_type' => "application/#{content_type}"}
+    body = WebMock::Util::QueryMapper.query_to_values(body) unless content_type == 'json'
+    @request = stub_request(:post, url).with(body: body, headers: headers).to_return(@response_body)
+  end
+end

data/spec/globe_labs/main_spec.rb

@@ -0,0 +1,31 @@
+require 'minitest/autorun'
+require 'webmock/minitest'
+require 'globe_labs'
+
+describe 'GlobeLabs::Main' do
+  before do
+    @key = 'key'
+    @secret = 'secret'
+    @short_code = '1234'
+    @globe = GlobeLabs::Client.new(key: @key, secret: @secret, short_code: @short_code)
+    @code = 'code'
+    @auth_host = 'https://developer.globelabs.com.ph'
+    @response_body = {body: {key: 'value'}.to_json, headers: {'Content-Type' => 'application/json;charset=utf-8'}}
+    @response_object = {"key" => 'value'}
+  end
+
+  describe '#get_access_token' do
+    it 'returns access token and subscriber' do
+      body = "app_id=#@key&app_secret=#@secret&code=#@code"
+      stub_post("#@auth_host/oauth/access_token", body)
+      @globe.get_access_token(@code).must_equal @response_object
+    end
+  end
+
+  private
+  def stub_post(url, body)
+    headers = {'Content_type' => "application/x-www-form-urlencoded"}
+    body = WebMock::Util::QueryMapper.query_to_values(body)
+    @request = stub_request(:post, url).with(body: body, headers: headers).to_return(@response_body)
+  end
+end

data/spec/globe_labs/params_spec.rb

@@ -0,0 +1,18 @@
+require 'minitest/autorun'
+require 'globe_labs'
+
+describe 'GlobeLabs::Params' do
+  describe 'encode method' do
+    it 'returns a url encoded string containing the given params' do
+      params = {app_id: 'key', secret: 'secret', short_code: '1234'}
+
+      GlobeLabs::Params.encode(params).must_equal('app_id=key&secret=secret&short_code=1234')
+    end
+
+    it 'flattens array values into multiple key value pairs' do
+      params = {'ids' => %w[001A 001B 001C]}
+
+      GlobeLabs::Params.encode(params).must_equal('ids=001A&ids=001B&ids=001C')
+    end
+  end
+end

metadata

@@ -0,0 +1,101 @@
+--- !ruby/object:Gem::Specification
+name: globe_labs
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Jaemar Ramos
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-10-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+description: Globe Labs Client Library for Ruby
+email:
+- jaemar.ramos@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE.txt
+- README.md
+- globe_labs.gemspec
+- lib/globe_labs.rb
+- lib/globe_labs/client.rb
+- lib/globe_labs/errors/authentication_error.rb
+- lib/globe_labs/errors/client_error.rb
+- lib/globe_labs/errors/error.rb
+- lib/globe_labs/errors/server_error.rb
+- lib/globe_labs/main.rb
+- lib/globe_labs/params.rb
+- lib/globe_labs/version.rb
+- spec/globe_labs/client_spec.rb
+- spec/globe_labs/main_spec.rb
+- spec/globe_labs/params_spec.rb
+homepage: 
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 1.9.3
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.13
+signing_key: 
+specification_version: 4
+summary: Ruby client library for Globe Labs' API.
+test_files: []