transfer_to 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 2e00bcf3929974ec3401ec726a90aac36d75b06a
+  data.tar.gz: 926d7948ed5fdb4818bd23019f07c66a84a2ce5f
+SHA512:
+  metadata.gz: 2e0a876c2acb854f3cdcee54db5d6bf33f00ab4f59a962ae347ae74db4b53288181f0196968558db651f739aa4b52f2372389c63b214200265f2bbac31a90726
+  data.tar.gz: a563d0072d5cb4332e47290228468fb16c169113452188b8306ba3f4f87921b3cd8b7740af4eafd89dbec0188da353744866d8b847e88deae3287d9d3b767d84

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in transfer_to.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Nikhil Gupta
+
+MIT License
+
+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,29 @@
+# TransferTo
+
+TODO: Write a gem description
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'transfer_to'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install transfer_to
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/lib/transfer_to.rb

@@ -0,0 +1,12 @@
+require "pry"
+require "faraday"
+require "net/http"
+
+# require transfer_to files..
+require "transfer_to/version"
+require "transfer_to/errors"
+require "transfer_to/request"
+require "transfer_to/reply"
+require "transfer_to/base"
+require "transfer_to/api"
+require "transfer_to/dsl"

data/lib/transfer_to/api.rb

@@ -0,0 +1,175 @@
+module TransferTo
+  class API < Base
+
+    # This method can be used when you want to test the connection and your
+    # account credentials.
+    def ping
+      run_action :ping
+    end
+
+    # This function is used to retrieve the credit balance in your TransferTo
+    # account.
+    def check_wallet
+      run_action :check_wallet
+    end
+
+    # This method is used to recharge a destination number with a specified
+    # denomination (“product” field).
+    # This is the API’s most important action as it is required when sending
+    # a topup to a prepaid account phone numberin a live! environment.
+    #
+    # parameters
+    # ==========
+    # msisdn
+    # ------
+    # The international phone number of the user requesting to credit
+    # a TransferToAPI phone number. The format must contain the country code,
+    # and will be valid with or without the ‘+’ or ‘00’ placed before it. For
+    # example: “6012345678” or “+6012345678” or “006012345678” (Malaysia) are
+    # all valid.
+    #
+    # product
+    # -------
+    # This field is used to define the remote product(often, the same as the
+    # amount in destination currency) to use in the request.
+    #
+    # destination
+    # -----------
+    # This is the destination phone number that will be credited with the
+    # amount transferred. Format is similar to “msisdn”.
+    #
+    # operator_id
+    # -----------
+    # It defines the operator id of the destination MSISDN that must be used
+    # when treating the request. If set, the platform will be forced to use
+    # this operatorID and will not identify the operator of the destination
+    # MSISDN based on the numbering plan. It must be very useful in case of
+    # countries with number portability if you are able to know the destination
+    # operator.
+
+    def topup(msisdn, destination, product, reserved_id = nil,
+              recipient_sms = nil, sender_sms = nil, operator_id = nil)
+      @params     = { msisdn: msisdn, destination_msisdn: destination, product: product }
+      self.oid    = operator_id
+
+      @params.merge({
+        cid1: "", cid2: "", cid3: "",
+        reserved_id: reserved_id,
+        sender_sms: (sender_sms ? "yes" : "no"),
+        sms: recipient_sms,
+        sender_text: sender_sms,
+        delivered_amount_info: "1",
+        return_service_fee: "1",
+        return_timestamp: "1",
+        return_version: "1"
+      })
+
+      run_action :topup
+    end
+
+    # This method is used to retrieve various information of a specific MSISDN
+    # (operator, country…) as well as the list of all products configured for
+    # your specific account and the destination operator of the MSISDN.
+    def msisdn_info(msisdn, operator_id=nil)
+      @params = {
+        destination_msisdn: msisdn,
+        delivered_amount_info: "1",
+        return_service_fee: 1
+      }
+      self.oid = operator_id
+      run_action :msisdn_info
+    end
+
+    # This method can be used to retrieve available information on a specific
+    # transaction. Please note that values of “input_value” and
+    # “debit_amount_validated” are rounded to 2 digits after the comma but are
+    # the same as the values returned in the fields “input_value” and
+    # “validated_input_value” of the “topup” method response.
+    def trans_info(id)
+      @params = { transactionid: id }
+      run_action :trans_info
+    end
+
+    # This method is used to retrieve the list of transactions performed within
+    # the date range by the MSISDN if set. Note that both dates are included
+    # during the search.
+    #
+    # parameters
+    # ==========
+    # msisdn
+    # ------
+    # The format must be international with or without the ‘+’ or ‘00’:
+    # “6012345678” or “+6012345678” or “006012345678” (Malaysia)
+    #
+    # destination_msisdn
+    # ------------------
+    # The format must be international with or without the ‘+’ or ‘00’:
+    # “6012345678” or “+6012345678” or “006012345678” (Malaysia)
+    #
+    # code
+    # ----
+    # The error_code of the transactions to search for. E.g “0” to search for
+    # only all successful transactions. If left empty, all transactions will be
+    # returned(Failed and successful).
+    #
+    # start_date
+    # ----------
+    # Defines the start date of the search. Format must be YYYY-MM-DD.
+    #
+    # stop_date
+    # ---------
+    # Defines the end date of the search (included). Format must be YYYY-MM-DD.
+
+    def trans_list(start, stop, msisdn = nil, destination = nil, code = nil)
+      @params[:code]               = code unless code
+      @params[:msisdn]             = msisdn unless msisdn
+      @params[:stop_date]          = to_yyyymmdd(stop)
+      @params[:start_date]         = to_yyyymmdd(start)
+      @params[:destination_msisdn] = destination unless destination
+      run_action :trans_list
+    end
+
+    # This method is used to reserve an ID in the system. This ID can then be
+    # used in the “topup” or “simulation” requests.
+    # This way, your system knows the IDof the transaction before sending the
+    # request to TransferTo (else it will only be displayed in the response).
+    def reserve_id
+      run_action :reserve_id
+    end
+
+    # This method is used to retrieve the ID of a transaction previously
+    # performed based on the key used in the request at that time.
+    def get_id_from_key(key)
+      @params = { from_key: key }
+      run_action :get_id_from_key
+    end
+
+    # This method is used to retrieve coverage and pricelist offered to you.
+    # parameters
+    # ==========
+    # info_type
+    # ---------
+    #   i) “countries”: Returns a list of all countries offered to you
+    #  ii) “country”  : Returns a list of operators in the country
+    # iii) “operator” : Returns a list of wholesale and retail price for the operator
+    #
+    # content
+    # -------
+    #   i) Not used if info_type = “countries”
+    #  ii) countryid of the requested country if info_type = “country”
+    # iii) operatorid of the requested operator if info_type = “operator”
+
+    def pricelist(info_type, content = nil)
+      @params[:info_type] = info_type
+      @params[:content] = content unless content
+      run_action :pricelist
+    end
+
+    private
+
+    def oid=(operator_id)
+      @params[:operatorid] = operator_id.to_i if operator_id.is_a?(Integer)
+    end
+
+  end
+end

data/lib/transfer_to/base.rb

@@ -0,0 +1,31 @@
+module TransferTo
+  class Base
+
+    attr_reader :reply, :request
+
+    def initialize(user, password)
+      aurl     = "https://fm.transfer-to.com:5443"
+      @params  = {}
+      @request = ::TransferTo::Request.new user, password, aurl
+    end
+
+    def run_action(name, method = :get)
+
+      @request.action = name
+      @request.params = @params
+
+      @request.run(method).on_complete do |reply|
+        @reply = ::TransferTo::Reply.new(reply)
+        raise ::TransferTo::Error.new @reply.error_code, @reply.error_message unless @reply.success?
+        return @reply
+      end
+    end
+
+    def test_numbers(num = nil)
+      numbers = [ "628123456710", "628123456770", "628123456780",
+                  "628123456781", "628123456790", "628123456798",
+                  "628123456799" ]
+      num > 0 && num < 8 ? numbers[num-1] : numbers
+    end
+  end
+end

data/lib/transfer_to/dsl.rb

@@ -0,0 +1,19 @@
+module TransferTo
+  class DSL < API
+
+    # check the status of the TranferTo API
+    def check_status
+      self.ping
+      reply.success? && reply.message == "pong" && reply.auth_key == request.key
+    end
+
+    # get information about a phone number
+    def phone_search(number, operator_id = nil)
+      information = msisdn_info(number, operator_id).information
+      information[:product_list] = information[:product_list].split(",")
+      information
+    end
+
+  end
+end
+

data/lib/transfer_to/errors.rb

@@ -0,0 +1,9 @@
+module TransferTo
+  class Error < StandardError
+    attr_reader :code
+    def initialize(code, message = nil)
+      @code = code.to_i
+      super(message)
+    end
+  end
+end

data/lib/transfer_to/reply.rb

@@ -0,0 +1,75 @@
+module TransferTo
+  class Reply
+
+    # "reply" as received from Faraday's request
+    def initialize(reply)
+      @response = reply.to_hash[:response]
+    end
+
+    def format_it
+      {
+        data: data,
+        status: status,
+        success: success?,
+        method: @response.env[:method],
+        url: url,
+        headers: headers,
+        raw_response: raw
+      }
+    end
+
+
+    ######## CONVENIENCE METHODS ##########
+
+    # get the actual data returned by the TransferTo API
+    def data
+      hash = {}
+      @response.body.lines.each do |line|
+        key, value = line.strip.split "="
+        hash[key.to_sym] = (key == "error_code") ? value.to_i : value
+      end; hash
+    end
+
+    def status
+      @response.status
+    end
+
+    def error_code
+      data[:error_code]
+    end
+
+    def error_message
+      data[:error_txt]
+    end
+
+    def success?
+      status == 200 && error_code == 0
+    end
+
+    def url
+      @response.env[:url].to_s
+    end
+
+    def information
+      data.reject do |key, value|
+        [:authentication_key, :error_code, :error_txt].include?(key)
+      end
+    end
+
+    def message
+      information[:info_txt]
+    end
+
+    def auth_key
+      data[:authentication_key]
+    end
+
+    def headers
+      @response.headers
+    end
+
+    def raw
+      @response.body
+    end
+  end
+end

data/lib/transfer_to/request.rb

@@ -0,0 +1,82 @@
+module TransferTo
+  class Request
+
+    attr_reader :user, :name, :params
+
+    def initialize(user, password, aurl = nil)
+      @user   = user
+      @pass   = password
+      @conn = Faraday.new(url: aurl) do |faraday|
+        faraday.request  :url_encoded
+        faraday.adapter  :net_http
+      end
+    end
+
+    def reset
+      @params = {}
+      authenticate
+    end
+
+    def authenticate
+      time = Time.now.to_i.to_s
+      add_param :key,   time
+      add_param :md5,   md5_hash(@user + @pass + time.to_s)
+      add_param :login, @user
+    end
+
+    def action=(name)
+      reset
+      @name = name
+      add_param :action, name
+    end
+
+    def params=(parameters)
+      @params.merge!(parameters)
+    end
+
+    def add_param(key, value)
+      @params[key.to_sym] = value
+    end
+
+    def key
+      @params[:key]
+    end
+
+    def get?
+      @params[:method] == :get
+    end
+
+    def post?
+      @params[:method] == :post
+    end
+
+    def run(method = :get)
+      add_param :method, method
+      @conn.send(method, "/cgi-bin/shop/topup", @params) do |req|
+        req.options = { timeout: 600, open_timeout: 600 }
+      end
+    end
+
+    private
+
+    def md5_hash(str)
+      (Digest::MD5.new << str).to_s
+    end
+
+    def to_time(time)
+      case time.class.name
+      when "String"  then return Time.parse(time)
+      when "Integer" then return Time.at(time)
+      when "Time"    then return time
+      else raise ArgumentError
+      end
+    rescue
+      Time.now
+    end
+
+    def to_yyyymmdd(time)
+      to_time(time).strftime("%Y-%m-%d")
+    end
+
+  end
+end

data/lib/transfer_to/version.rb

@@ -0,0 +1,3 @@
+module TransferTo
+  VERSION = "0.1.0"
+end

data/transfer_to.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'transfer_to/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "transfer_to"
+  spec.version       = TransferTo::VERSION
+  spec.authors       = ["Nikhil Gupta"]
+  spec.email         = ["me@nikhgupta.com"]
+  spec.description   = %q{Consumes TransferTo.com API and provides with ruby methods for the same}
+  spec.summary       = %q{Gem to consume TransferTo.com API}
+  spec.homepage      = "http://rubygems.org/gems/transfer_to"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+
+  spec.add_dependency "faraday"
+
+  spec.add_development_dependency "pry"
+end

metadata

@@ -0,0 +1,114 @@
+--- !ruby/object:Gem::Specification
+name: transfer_to
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Nikhil Gupta
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-08-18 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !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: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  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'
+description: Consumes TransferTo.com API and provides with ruby methods for the same
+email:
+- me@nikhgupta.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/transfer_to.rb
+- lib/transfer_to/api.rb
+- lib/transfer_to/base.rb
+- lib/transfer_to/dsl.rb
+- lib/transfer_to/errors.rb
+- lib/transfer_to/reply.rb
+- lib/transfer_to/request.rb
+- lib/transfer_to/version.rb
+- transfer_to.gemspec
+homepage: http://rubygems.org/gems/transfer_to
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.0.0
+signing_key: 
+specification_version: 4
+summary: Gem to consume TransferTo.com API
+test_files: []