idtbeyond 1.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 2f9a606a8eeaa5218023a248b6b0c97fb6dc5f04
+  data.tar.gz: c451d5133b61feff7a9653a270f04c5de0b5c548
+SHA512:
+  metadata.gz: 7109388298a1da61a7b057563a9d88aa19f70b71aac1e871883754ebd9a11dc47344ebd2485206c5075df539ed37e9957ca6e025bc1dacfdaf1be885642b8f4e
+  data.tar.gz: 598c07ccd5128b98f47f2afc8ad2ecae4f111a6cbefaf33688621eb42da5b4bdd56ec04cc99818810c812654bf5c924e4f371b475de2aab93a61bbb95a42823a

data/.gitignore

@@ -0,0 +1,15 @@
+/.bundle/
+/.idea/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/.ruby-gemset

@@ -0,0 +1 @@
+idtbeyond

data/.ruby-version

@@ -0,0 +1 @@
+ruby-2.2.1

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+gem 'faraday'
+gem 'json'
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 Robbie Holmes
+
+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,536 @@
+# Ruby Gem for IDT Beyond
+
+[![Join the chat at https://gitter.im/IDTLabs/IDTBeyond-Ruby](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/IDTLabs/IDTBeyond-Ruby?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
+
+The official node package for interacting with the IDT Beyond API.
+
+## Getting started with IDT Beyond
+
+To use this service, sign up for a free account at: [https://portal.idtbeyond.com](https://portal.idtbeyond.com), or read the documentation at [https://portal.idtbeyond.com/docs](https://portal.idtbeyond.com/docs).
+
+## Requirements
+
+- bundler
+- ruby 2.2.1
+
+
+## Setup your environment
+
+1. Make sure above requirements are fulfilled. (see site documentation in links above)
+2. run `npm install idtbeyond --save` to add this module to your project 
+
+## Testing
+
+Running `rake spec` will run the unit tests with RSpec 3.x.
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/idtbeyond/fork )
+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 a new Pull Request
+
+## Usage
+
+```ruby
+require "idtbeyond"
+```
+
+```ruby
+idtbeyond_iatu = IDTBeyond::Service::IATU.new "app-id", "app-key", "term-id"
+```
+
+<aside class="notice">
+Each application has a unique `app-id` and `app-key`. You can generate up to 5 keys per application, and they can be regenerated by you at any time. Make sure to use the correct ones, and update your code when new valid keys are generated.
+</aside>
+
+####Parameters
+
+Parameter | Required | Type | Description
+--------- | ------- | ----- | -----------
+app-id | true | string | Application ID.
+app-key | true | string | Application Key.
+term-id | true | string | Terminal name for the environment serving the application.
+
+## API Status
+
+This returns the status of the IDT Beyond API.
+
+**Request:**
+
+```ruby
+idtbeyond_iatu.get_status
+```
+
+**Response:**
+
+```json
+{
+   "alive":true
+}
+```
+
+## Get all products
+
+This endpoint retrieves a current list of products offered by our IATU API.
+
+**Request:**
+
+```ruby
+idtbeyond_iatu.get_products
+```
+
+```json
+[
+   {
+      "country":"Guatemala",
+      "country_code":"GT",
+      "carrier":"Tigo",
+      "carrier_code":"Tigo",
+      "mask":"502-XXXX-XXXX",
+      "denomination":700,
+      "minDenomination":700,
+      "maxDenomination":700,
+      "commission":"10"
+   },
+   {
+      "country":"Argentina",
+      "country_code":"AR",
+      "carrier":"Movistar",
+      "carrier_code":"Movistar",
+      "mask":"54-XXXX-XXX-XXXX",
+      "denomination":700,
+      "minDenomination":700,
+      "maxDenomination":700,
+      "commission":"14.50"
+   }
+]
+``` 
+
+## Local Value
+
+Get the local value of a particular product.
+
+### Example:
+
+`idtbeyond_iatu.get_local_value amount, "carrier_code", "country_code", "currency_code"`
+
+**Request:**
+
+```ruby
+idtbeyond_iatu.get_local_value "500", Claro, "GT", "USD"
+```
+
+**Response:**
+
+```json
+{	
+	"carrier_code":"Claro",
+	"country_code":"GT",
+	"amount":"500",
+	"currency_code":"USD",
+	"local_currency":"GTQ",
+	"local_amount":"3965",
+	"divisor":"100"
+}
+```
+
+####Parameters
+
+Parameter | Required | Type | Description
+--------- | ------- | ----- | -----------
+country_code | true | string | 2-digit code of the country in ISO 3166 format. Ex: CO for Columbia.
+carrier_code | true | string | Name of the mobile carrier. Ex: Tigo
+currency_code | true | string | The currency code (ISO 4217) on the product you are querying. Ex: USD
+amount | true | integer | The amount of the product you would like to get the value of. Ex: 1000 = $10.00 (in cents).
+
+
+## Balance
+
+This call allows you get the balance on a specific application. 
+
+**Request:**
+
+```ruby
+idtbeyond_iatu.get_balance
+```
+
+**Response:**
+
+```json
+{
+   "balance":986834,
+   "currency_code":"USD",
+   "currency_symbol":"$",
+   "currency_divisor":100
+}
+```
+
+## Topup
+
+This is how you topup a phone in another country.
+
+### Example:
+
+`idtbeyond_iatu.post_topup "amount", "carrier_code", "country_code", "mobile_number"`
+
+**Request:**
+
+```ruby
+idtbeyond_iatu.post_topup "1000", "Claro", "GT", "50212345678"
+```
+
+**Response:**
+
+```json
+{
+   "success":true,
+   "client_transaction_id":"trans_id_12345",
+   "transaction_id":"123345678",
+   "amount":1000,
+   "currency_divisor":"100",
+   "currency_symbol":"$",
+   "wholesaler_balance":0,
+   "wholesaler_commission":100,
+   "local_amount":7934,
+   "local_currency":"GTQ",
+   "local_divisor":"100",
+   "plan":"Sandbox",
+   "terminal_id":"kiosk 12",
+   "carrier_code":"Claro",
+   "country_code":"GT",
+   "country_name":"Guatemala",
+   "mobile_number":1234567890,
+   "to_service_number":"0987654321",
+   "from_service_number":"9999999999"
+}
+```
+
+<aside class="notice">
+Your `clientTransactionId` is automatically generated by default using the `generateClientTransactionId` function.
+</aside>
+
+####Parameters
+
+Parameter | Required | Type | Description
+--------- | ------- | ----- | -----------
+country_code | true | string | 2-digit code of the country in ISO 3166 format. (Ex: **GT** for Guatemala).
+carrier_code | true | string | Name of the mobile carrier. (Ex: **Claro**).
+amount | true | integer | This is the amount, in cents, of the product you are purchasing. (Ex: **500** = $5.00).
+mobile_number | true | integer | Mobile number to topup. VALIDATE prior to submission. (Ex: **50312345678**).
+
+##Topups Reports (all)
+
+This will return both the totals report, and the transactions during the dates requested.
+
+### Example:
+
+`idtbeyond_iatu.get_all_topups "date_from", "date_to"`
+
+**Request:**
+
+```ruby
+idtbeyond_iatu.get_all_topups "2015-01-04", "2015-01-05"
+```
+
+**Response:**
+
+```json
+{
+   "success":true,
+   "totals":{
+      "purchases":"0",
+      "transfers":"-500",
+      "commissions":"100",
+      "transactions_count":"1",
+      "actual_last_transaction_date":"2015-01-05T22:44:35",
+      "query_start_date":"2015-01-04",
+      "query_end_date":"2015-01-05"
+   },
+   "transactions":[
+      {
+         "mobile_number":"50212345678",
+         "production_pin":"0000000001",
+         "client_transaction_id":"Transaction123456",
+         "currency_code":"US",
+         "currency_symbol":"$",
+         "currency_divisor":"100",
+         "transaction_date":"2015-01-05T22:44:34",
+         "transaction_method":"XFER",
+         "transaction_description":"IMTU",
+         "transaction_amount":"-500",
+         "retail_amount":"-500",
+         "retail_commission":"100",
+         "account_start_balance":"60575",
+         "account_end_balance":"60175",
+         "product_name":"IMTU - CLARO UNIVERSAL $5"
+      }
+   ]
+}
+```
+
+####Parameters
+
+Parameter | Required | Type | Description
+--------- | ------- | ----- | -----------
+date_from | true | string | YYYY-MM-DD format. Starts at 00:00:00 Eastern Time (ET). (Ex: 2015-12-01).
+date_to | true | string | YYYY-MM-DD format. Ends at 23:59:59 Eastern Time (ET). (Ex: 2015-12-01).
+
+<aside class="success">
+Remember — All date_to and date_from queries are in Eastern Time (ET), by default.
+</aside>
+
+
+##Topups Reports (Totals)
+
+This returns a summary report of topups totals, within a given time period. 
+
+### Example:
+
+`idtbeyond_iatu.get_all_topups_totals "date_from", "date_to"`
+
+**Request:**
+
+```ruby
+idtbeyond_iatu.get_all_topups_totals "2015-01-01", "2015-01-02"
+```
+
+**Response:**
+
+```json
+{
+   "success":true,
+   "totals":{
+      "from_service_number":"133333333",
+      "sales":"50000",
+      "cost":"40000",
+      "commissions":"10000",
+      "transactions_count":"100",
+      "actual_last_transaction_date":"2015-01-02T23:59:59",
+      "query_start_date":"2015-01-01",
+      "query_end_date":"2015-01-02",
+      "currency_code":"US",
+      "currency_symbol":"$",
+      "currency_divisor":"100"
+   }
+}
+```
+
+####Parameters
+
+Parameter | Required | Type | Description
+--------- | ------- | ----- | -----------
+date_from | true | string | YYYY-MM-DD format. Starts at 00:00:00 Eastern Time (ET). (Ex: 2015-12-01).
+date_to | true | string | YYYY-MM-DD format. Ends at 23:59:59 Eastern Time (ET). (Ex: 2015-12-01).
+
+<aside class="success">
+Remember — All date_to and date_from queries are in Eastern Time (ET), by default.
+</aside>
+
+##Topups Reports (Search)
+
+Search for transaction details using your **client_transaction_id**.
+
+### Example:
+
+`idtbeyond_iatu.client_transaction_id_search "client_transaction_id", "date_from", "date_to"`
+
+**Request:**
+
+```ruby
+idtbeyond_iatu.client_transaction_id_search "my-client-trans-id", "2015-03-01", "2015-03-11"
+```
+
+**Response:**
+
+```json
+{
+   "success":true,
+   "transaction_data":[
+      {
+         "currency_code":"USD",
+         "currency_symbol":"$",
+         "currency_divisor":"100",
+         "client_transaction_id":"my-client-trans-id",
+         "transaction_date":"3/1/2015 10:57:04 AM",
+         "description":"Success",
+         "commission":"100",
+         "type":"IMTU - CLARO UNIVERSAL $5",
+         "end_balance":"56915",
+         "amount":"-500",
+         "terminal_id":"testTerminalId",
+         "transaction_status":"Success",
+         "to_service_number":"117123456"
+      }
+   ]
+}
+```
+
+####Parameters
+
+Parameter | Required | Type | Description
+--------- | ------- | ----- | -----------
+date_from | true | string | YYYY-MM-DD format. Starts at 00:00:00 Eastern Time (ET). (Ex: **2015-12-01**).
+date_to | true | string | YYYY-MM-DD format. Ends at 23:59:59 Eastern Time (ET). (Ex: **2015-12-01**).
+client_transaction_id | true | string | A unique id you use to track topups (Limit of 20 characters).
+
+<aside class="success">
+Remember — All date_to and date_from queries are in Eastern Time (ET), by default.
+</aside>
+
+
+##Topups Reports (Quick Status)
+
+When you submit a transaction, we do some very detailed handling to complete the request. The **to_service_number** is a tracking method used to follow the status of this request, including the balance of the transaction handoff to the carrier. Use this endpoint to get a quick update on the status of the request.
+
+### Example:
+
+`idtbeyond_iatu.to_service_number_search "to_service_number"`
+
+**Request:**
+
+```ruby
+idtbeyond_iatu.to_service_number_search "2712345678"
+```
+
+**Response:**
+
+```json
+{
+	"success": true,
+	"transaction_data": {
+		"balance": "0",
+		"status": "Redeemed"
+	}
+}
+```
+
+####Parameters
+
+Parameter | Required | Type | Description
+--------- | ------- | ----- | -----------
+to_service_number | true | string | A unique IDT transaction number that gives the status of the transfer of funds from your account to the carrier.
+
+
+##Topups (Reverse)
+
+Use this method to search for the status of a particular topup transaction, using the unique **clientTransactionId** you supplied in the request, and use the **toServiceNumber**.
+
+Occasionally, a carrier will not be able to successfully complete a topup request. In this case, we will attempt to automatically reverse the transaction for you, and return the money into your account. In the case when this is not possible, you may need to request a reverse on the transaction that has a status of **"status": "Not Redeemed"**.
+
+### Example:
+
+`idtbeyond_iatu.reverse_topup "client_transaction_id", "to_service_number"`
+
+**Request:**
+
+```ruby
+idtbeyond_iatu.reverse_topup "my-client-trans-id", "2712345678"
+```
+
+**Response:**
+
+```json
+{
+   "success":true,
+   "account_id":"12345678",
+   "client_transaction_id":"my-client-trans-id",
+   "transaction_id":"111222333",
+   "to_service_number":"2712345678",
+   "remaining_amount":0,
+   "currency_symbol":"$",
+   "currency_divisor":"100"
+}
+```
+
+
+####Parameters
+
+Parameter | Required | Type | Description
+--------- | ------- | ----- | -----------
+client_transaction_id | true | string | A unique id you use to track topups (Limit of 16 characters).
+to_service_number | true | string | The service number of the financial transaction (moving the money between your balance and the carrier).
+
+## Charges Reports (all)
+
+Returns a list of any credit card charges, wire-transfers, or credit adjustments on your application account.
+**Request:**
+
+```ruby
+idtbeyond_iatu.get_all_charges "2015-03-01", "2015-03-11"
+```
+
+**Response:**
+
+```json
+{
+   "success":true,
+   "totals":{
+      "purchases":"0",
+      "transfers":"0",
+      "commissions":"0",
+      "transactions_count":"1",
+      "actual_last_transaction_date":"2015-03-02T20:04:45",
+      "query_start_date":"2015-03-01",
+      "query_end_date":"2015-03-11"
+   },
+   "transactions":[
+      {
+         "mobile_number":"",
+         "production_pin":"",
+         "client_transaction_id":"12345678",
+         "currency_code":"US",
+         "currency_symbol":"$",
+         "currency_divisor":"100",
+         "transaction_date":"2015-03-02T20:04:44",
+         "transaction_method":"CREDIT_LOAD",
+         "transaction_description":"Credit Load",
+         "transaction_amount":"100000",
+         "retail_commission":"0",
+         "account_start_balance":"0",
+         "account_end_balance":"100000",
+         "product_name":"CREDIT_LOAD"
+      }
+   ]
+}
+```
+
+
+####Parameters
+
+Parameter | Required | Type | Description
+--------- | ------- | ----- | -----------
+date_from | true | string | YYYY-MM-DD format. Starts at 00:00:00 Eastern Time (ET). (Ex: 2015-12-01).
+date_to | true | string | YYYY-MM-DD format. Ends at 23:59:59 Eastern Time (ET). (Ex: 2015-12-01).
+
+<aside class="success">
+Remember — All date_to and date_from queries are in Eastern Time (ET), by default.
+</aside>
+
+##Number Validator
+
+This method validates that a phone number has a valid area code and number of digits for the selected country.
+
+**Request:**
+
+```ruby
+idtbeyond_iatu.validate_number "GT", "50212345678"
+```
+
+**Response:**
+
+```json
+{
+   "country_code":"GT",
+   "mobile_number":"50212345678",
+   "valid":true
+}
+```
+
+####Parameters
+
+Parameter | Required | Type | Description
+--------- | ------- | ----- | -----------
+country_code | true | string | 2-digit code of the country in ISO 3166 format. (Ex: **BR** for Brazil).
+mobile_number | true | string | Mobile number to topup. VALIDATE prior to submission. (Ex: **5521983339000**).

data/Rakefile

@@ -0,0 +1,9 @@
+require "bundler/gem_tasks"
+require 'rspec/core/rake_task'
+
+
+# Default directory to look in is `/specs`
+# Run with `rake spec`
+RSpec::Core::RakeTask.new('spec')
+
+task :default => :spec

data/idtbeyond.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'idtbeyond/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "idtbeyond"
+  spec.version       = IDTBeyond::VERSION
+  spec.authors       = ["Robbie Holmes"]
+  spec.email         = ["robbiethegeek@gmail.com"]
+  spec.summary       = %q{The gem for interacting with the IDTBeyond API.}
+  spec.description   = %q{This gem will allow developers to interact with the IDTBeyond API for all published services.}
+  spec.homepage      = "https://github.com/IDTLabs/IDTBeyond-Ruby"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  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.6"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "webmock"
+  spec.add_development_dependency "pry"
+end

data/lib/idtbeyond.rb

@@ -0,0 +1,6 @@
+require "idtbeyond/version"
+require "idtbeyond/services/imtu"
+
+module IDTBeyond
+
+end

data/lib/idtbeyond/services/imtu.rb

@@ -0,0 +1,114 @@
+require "faraday"
+require "json"
+
+module IDTBeyond
+  class Service
+    class IATU
+      # Constructor
+      def initialize(app_id = nil, app_key = nil, term_id = nil)
+        raise "app_id, app_key and term_id are required" if app_key.nil? || app_id.nil? || term_id.nil?
+        @app_id = app_id
+        @app_key = app_key
+        @term_id = term_id
+        @url = ENV["IDTBEYOND_API_URL"] || "https://api.idtbeyond.com"
+        @plan_type = ENV["IDTBEYOND_PLAN_TYPE"] || "Production"
+        @conn = Faraday.new(:url => @url, :headers => {
+          "x-idt-beyond-app-id" => @app_id,
+          "x-idt-beyond-app-key" => @app_key
+        }) do |faraday|
+          faraday.request :url_encoded
+          faraday.response :logger
+          faraday.adapter Faraday.default_adapter
+        end
+      end
+
+      # API Methods
+
+      def client_transaction_id_search(client_transaction_id, date_from, date_to)
+        response = @conn.post "/v1/iatu/topups/reports", {
+        :client_transaction_id => client_transaction_id,
+        :type_of_report => "client_transaction_id",
+        :date_from => date_from,
+        :date_to => date_to
+        }
+        JSON response.body
+      end
+      def get_all_charges(date_from, date_to)
+        response = @conn.get "/v1/iatu/charges/reports/all", {:date_from => date_from, :date_to => date_to}
+        return JSON response.body if response.status == 200
+        false
+      end
+      def get_all_topups(date_from, date_to)
+        response = @conn.get "/v1/iatu/topups/reports/all", {:date_from => date_from, :date_to => date_to}
+        return JSON response.body if response.status == 200
+        false
+      end
+      def get_all_topups_totals(date_from, date_to)
+        response = @conn.get "/v1/iatu/topups/reports/totals", {:date_from => date_from, :date_to => date_to}
+        return JSON response.body if response.status == 200
+        false
+      end
+      def get_app_id
+        @app_id
+      end
+
+      def get_app_key
+        @app_key
+      end
+      def get_balance
+        response = @conn.get "/v1/iatu/balance"
+        return JSON response.body if response.status == 200
+        false
+      end
+      def get_local_value(amount, carrier_code, country_code, currency_code)
+        response = @conn.get "/v1/iatu/products/reports/local-value", {
+        :carrier_code => carrier_code,
+        :country_code => country_code,
+        :currency_code => currency_code,
+        :amount => amount
+        }
+        JSON response.body
+      end
+
+      def get_status
+        response = @conn.get "/v1/status"
+        p response
+        return JSON response.body if response.status == 200
+        false
+      end
+
+      def post_topup(amount, carrier_code, country_code, mobile_number )
+        client_transaction_id = @app_id + "-" + "%06d" % Random.rand(0..999999)
+        response = @conn.post "/v1/iatu/topups", {
+        :country_code => country_code,
+        :carrier_code => carrier_code,
+        :client_transaction_id => client_transaction_id,
+        :terminal_id => @term_id,
+        :mobile_number => mobile_number,
+        :plan => @plan_type,
+        :amount => amount
+        }
+        JSON response.body
+      end
+      def reverse_topup(client_transaction_id, to_service_number)
+        response = @conn.post "/v1/iatu/topups/reverse", {
+                                                           :client_transaction_id => client_transaction_id,
+                                                           :to_service_number => to_service_number
+                                                       }
+        JSON response.body
+      end
+      def to_service_number_search(to_service_number)
+        response = @conn.post "/v1/iatu/topups/reports", {
+        :to_service_number => to_service_number,
+        :type_of_report => "to_service_number"
+        }
+        JSON response.body
+      end
+      def validate_number(country_code, mobile_number)
+        response = @conn.get "/v1/iatu/number-validator", {
+                                                            :country_code => country_code, :mobile_number => mobile_number}
+        JSON response.body
+      end
+    end
+  end
+end

data/lib/idtbeyond/version.rb

@@ -0,0 +1,3 @@
+module IDTBeyond
+  VERSION = "1.0.1"
+end

data/spec/imtu_spec.rb

@@ -0,0 +1,218 @@
+require "spec_helper"
+require "webmock"
+describe "IDTBeyond - IMTU" do
+  before(:each) do
+    @idtbeyond = IDTBeyond::Service::IATU.new "app-id", "app-key", "test term id"
+
+  end
+  describe "client_transaction_id_search" do
+    it "should call the /v1/iatu/topups/reports" do
+      stub_request(:post, "https://api.idtbeyond.com/v1/iatu/topups/reports").
+          with(
+              :body => {
+                  "client_transaction_id"=>"client-transaction-id",
+                  "date_from" => "date-from",
+                  "date_to" => "date-to",
+                  "type_of_report"=>"client_transaction_id" },
+              :headers => {
+                  "Accept"=>"*/*",
+                  "Accept-Encoding"=>"gzip;q=1.0,deflate;q=0.6,identity;q=0.3",
+                  "Content-Type"=>"application/x-www-form-urlencoded",
+                  "User-Agent"=>"Faraday v0.9.1",
+                  "X-Idt-Beyond-App-Id"=>"app-id",
+                  "X-Idt-Beyond-App-Key"=>"app-key"}).
+          to_return(:status => 200, :body => "{\"success\":true}", :headers => {})
+      response = @idtbeyond.client_transaction_id_search("client-transaction-id", "date-from", "date-to")
+      expect(response["success"]).to eq(true)
+    end
+  end
+  describe "get_all_charges" do
+    it "should call the /v1/iatu/charges/reports/all" do
+      stub_request(
+      :get,
+      "https://api.idtbeyond.com/v1/iatu/charges/reports/all?date_from=date-from&date_to=date-to").
+      with(
+      :headers => {
+    "Accept"=>"*/*",
+    "Accept-Encoding"=>"gzip;q=1.0,deflate;q=0.6,identity;q=0.3",
+    "User-Agent"=>"Faraday v0.9.1",
+    "X-Idt-Beyond-App-Id"=>"app-id",
+    "X-Idt-Beyond-App-Key"=>"app-key"}).
+      to_return(:status => 200, :body => "{\"success\":true}", :headers => {})
+
+      response = @idtbeyond.get_all_charges("date-from", "date-to")
+      expect(response["success"]).to eq(true)
+    end
+  end
+  describe "get_all_topups" do
+    it "should call the /v1/iatu/topups/reports/all" do
+      stub_request(
+      :get,
+      "https://api.idtbeyond.com/v1/iatu/topups/reports/all?date_from=date-from&date_to=date-to").
+      with(
+      :headers => {
+    "Accept"=>"*/*",
+    "Accept-Encoding"=>"gzip;q=1.0,deflate;q=0.6,identity;q=0.3",
+    "User-Agent"=>"Faraday v0.9.1",
+    "X-Idt-Beyond-App-Id"=>"app-id",
+    "X-Idt-Beyond-App-Key"=>"app-key"}).
+      to_return(:status => 200, :body => "{\"success\":true}", :headers => {})
+      response = @idtbeyond.get_all_topups("date-from", "date-to")
+      expect(response["success"]).to eq(true)
+    end
+  end
+  describe "get_all_topups_totals" do
+    it "should call the /v1/iatu/topups/reports/totals" do
+      stub_request(
+      :get,
+      "https://api.idtbeyond.com/v1/iatu/topups/reports/totals?date_from=date-from&date_to=date-to").
+      with(
+      :headers => {
+    "Accept"=>"*/*",
+    "Accept-Encoding"=>"gzip;q=1.0,deflate;q=0.6,identity;q=0.3",
+    "User-Agent"=>"Faraday v0.9.1",
+    "X-Idt-Beyond-App-Id"=>"app-id",
+    "X-Idt-Beyond-App-Key"=>"app-key"}).
+      to_return(:status => 200, :body => "{\"success\":true}", :headers => {})
+
+      response = @idtbeyond.get_all_topups_totals("date-from", "date-to")
+      expect(response["success"]).to eq(true)
+    end
+  end
+  describe "get_app_id" do
+    it "returns the app id that was passed in during instantiation " do
+      expect(@idtbeyond.get_app_id).to eq("app-id")
+    end
+  end
+  describe "get_app_key" do
+    it "returns the app key that was passed in during instantiation " do
+      expect(@idtbeyond.get_app_key).to eq("app-key")
+    end
+  end
+  describe "get_balance" do
+    it "should call the /v1/iatu/balance" do
+      stub_request(:get, "https://api.idtbeyond.com/v1/iatu/balance").
+      with(
+      :headers => {
+    "Accept"=>"*/*",
+    "Accept-Encoding"=>"gzip;q=1.0,deflate;q=0.6,identity;q=0.3",
+    "User-Agent"=>"Faraday v0.9.1",
+    "X-Idt-Beyond-App-Id"=>"app-id",
+    "X-Idt-Beyond-App-Key"=>"app-key"}).
+      to_return(:status => 200, :body => "{\"success\":true}", :headers => {})
+
+      response = @idtbeyond.get_balance
+      expect(response["success"]).to eq(true)
+    end
+  end
+  describe "get_local_value" do
+    it "should call the /v1/iatu/number-validator" do
+      stub_request(
+      :get,
+      "https://api.idtbeyond.com/v1/iatu/products/reports/local-value?amount=amount&carrier_code=carrier-code&country_code=country-code&currency_code=currency-code").
+      with(
+      :headers => {
+    "Accept"=>"*/*",
+    "Accept-Encoding"=>"gzip;q=1.0,deflate;q=0.6,identity;q=0.3",
+    "User-Agent"=>"Faraday v0.9.1",
+    "X-Idt-Beyond-App-Id"=>"app-id",
+    "X-Idt-Beyond-App-Key"=>"app-key"}).
+      to_return(:status => 200, :body => "{\"success\":true}", :headers => {})
+      response = @idtbeyond.get_local_value("amount", "carrier-code", "country-code", "currency-code")
+      expect(response["success"]).to eq(true)
+    end
+  end
+  describe "get_status" do
+    it "should call the /v1/status" do
+      stub_request(:get, "https://api.idtbeyond.com/v1/status").
+      with(:headers => {
+    "Accept"=>"*/*",
+    "Accept-Encoding"=>"gzip;q=1.0,deflate;q=0.6,identity;q=0.3",
+    "User-Agent"=>"Faraday v0.9.1",
+    "X-Idt-Beyond-App-Id"=>"app-id",
+    "X-Idt-Beyond-App-Key"=>"app-key"}).
+      to_return(:status => 200, :body => "{\"alive\":true}", :headers => {})
+      response = @idtbeyond.get_status
+      expect(response["alive"]).to eq(true)
+    end
+  end
+  describe "post_topup" do
+    it "should call the /v1/iatu/topups" do
+      stub_request(:post, "https://api.idtbeyond.com/v1/iatu/topups").
+      with(
+      :body => {
+    "amount"=>"amount",
+    "carrier_code"=>"carrier-code",
+    "client_transaction_id"=>/app-id-\d+/,
+    "country_code"=>"country-code",
+    "mobile_number"=>"phone-number",
+    "plan"=>"Production",
+    "terminal_id"=>"test term id"},
+      :headers => {
+    "Accept"=>"*/*",
+    "Accept-Encoding"=>"gzip;q=1.0,deflate;q=0.6,identity;q=0.3",
+    "Content-Type"=>"application/x-www-form-urlencoded",
+    "User-Agent"=>"Faraday v0.9.1",
+    "X-Idt-Beyond-App-Id"=>"app-id",
+    "X-Idt-Beyond-App-Key"=>"app-key"}).
+      to_return(:status => 200, :body => "{\"success\":true}", :headers => {})
+      response = @idtbeyond.post_topup "amount", "carrier-code", "country-code", "phone-number"
+      expect(response["success"]).to eq(true)
+    end
+  end
+  describe "reverse_topup" do
+    it "should call the /v1/iatu/topups/reverse" do
+      stub_request(:post, "https://api.idtbeyond.com/v1/iatu/topups/reverse").
+      with(
+      :body => {
+    "client_transaction_id"=>"client-transaction-id",
+    "to_service_number"=>"to-service-number"},
+      :headers => {
+    "Accept"=>"*/*",
+    "Accept-Encoding"=>"gzip;q=1.0,deflate;q=0.6,identity;q=0.3",
+    "Content-Type"=>"application/x-www-form-urlencoded",
+    "User-Agent"=>"Faraday v0.9.1",
+    "X-Idt-Beyond-App-Id"=>"app-id",
+    "X-Idt-Beyond-App-Key"=>"app-key"}).
+      to_return(:status => 200, :body => "{\"success\":true}", :headers => {})
+      response = @idtbeyond.reverse_topup "client-transaction-id", "to-service-number"
+      expect(response["success"]).to eq(true)
+    end
+  end
+  describe "to_service_number_search" do
+    it "should call the /v1/iatu/topups/reports" do
+      stub_request(:post, "https://api.idtbeyond.com/v1/iatu/topups/reports").
+      with(
+      :body => {
+    "to_service_number"=>"to-service-number",
+    "type_of_report"=>"to_service_number" },
+      :headers => {
+    "Accept"=>"*/*",
+    "Accept-Encoding"=>"gzip;q=1.0,deflate;q=0.6,identity;q=0.3",
+    "Content-Type"=>"application/x-www-form-urlencoded",
+    "User-Agent"=>"Faraday v0.9.1",
+    "X-Idt-Beyond-App-Id"=>"app-id",
+    "X-Idt-Beyond-App-Key"=>"app-key"}).
+      to_return(:status => 200, :body => "{\"success\":true}", :headers => {})
+      response = @idtbeyond.to_service_number_search("to-service-number")
+      expect(response["success"]).to eq(true)
+    end
+  end
+  describe "validate_number" do
+    it "should call the /v1/iatu/number-validator" do
+      stub_request(
+      :get,
+      "https://api.idtbeyond.com/v1/iatu/number-validator?country_code=country-code&mobile_number=phone-number").
+      with(
+      :headers => {
+    "Accept"=>"*/*",
+    "Accept-Encoding"=>"gzip;q=1.0,deflate;q=0.6,identity;q=0.3",
+    "User-Agent"=>"Faraday v0.9.1",
+    "X-Idt-Beyond-App-Id"=>"app-id",
+    "X-Idt-Beyond-App-Key"=>"app-key"}).
+      to_return(:status => 200, :body => "{\"success\":true}", :headers => {})
+      response = @idtbeyond.validate_number("country-code", "phone-number")
+      expect(response["success"]).to eq(true)
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,8 @@
+require 'pry'
+require 'idtbeyond'
+require 'idtbeyond/services/imtu'
+require 'webmock/rspec'
+require 'webmock/rspec/matchers'
+require 'webmock/rspec/matchers/request_pattern_matcher'
+require 'webmock/rspec/matchers/webmock_matcher'
+WebMock.disable_net_connect!(allow_localhost: true)

metadata

@@ -0,0 +1,130 @@
+--- !ruby/object:Gem::Specification
+name: idtbeyond
+version: !ruby/object:Gem::Version
+  version: 1.0.1
+platform: ruby
+authors:
+- Robbie Holmes
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-04-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  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: webmock
+  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: 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: This gem will allow developers to interact with the IDTBeyond API for
+  all published services.
+email:
+- robbiethegeek@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".ruby-gemset"
+- ".ruby-version"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- idtbeyond.gemspec
+- lib/idtbeyond.rb
+- lib/idtbeyond/services/imtu.rb
+- lib/idtbeyond/version.rb
+- spec/imtu_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/IDTLabs/IDTBeyond-Ruby
+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.4.6
+signing_key: 
+specification_version: 4
+summary: The gem for interacting with the IDTBeyond API.
+test_files:
+- spec/imtu_spec.rb
+- spec/spec_helper.rb