mxit_api 0.1.0.pre → 0.2.0.pre

data/README.md

@@ -25,17 +25,48 @@ Examples
 ========
 
 Prerequisites (usually found on the mxit dashboard http://code.mxit.com/MobiDashboard/Default.aspx):
-* MXIT_CLIENT_ID
-* MXIT_CLIENT_SECRET
+* ruby 1.9.2
+* mxit client id
+* mxit secret id
 
 
-Authorization API
-----------------------------------------
+Messaging
+----------------
+http://dev.mxit.com/docs/api/messaging/post-message-send
 
+```ruby
+ connection = MxitApi.new(client_id, client_secret, {grant_type: 'client_credentials', scope: 'message/send'})
+ connection.send_message(to: "m123,m345", from: "yourappname", body: "This is a mxit message")
+```  
 
-Messaging API
+User Profile
 ----------------
+http://dev.mxit.com/docs/authentication#OAuth2_Flows
+http://dev.mxit.com/docs/api/user/get-user-profile
 
+```ruby
+   connection = MxitApi.new(client_id, client_secret, {:grant_type => 'authorization_code',
+                                                       :code => "code from authentication",
+                                                       :redirect_uri => "http://you.host/redirect/url")
+   result = connection.profile
+   result[:display_name] 
+   result[:gender] 
+   # etc
+
+```
 
-User API
-----------------
+MxitMoney
+----------------
+
+```ruby
+   connection = MxitMoneyApi.connect('mxit_money_client_id')
+   if connection
+    result = connection.user_info("m40000000000")
+    if result[:is_registered]
+        connection.issue_money(:phone_number => result[:msisdn],
+                               :merchant_reference => "#{result[:login_name]}#{rand(8999) + 1000}",
+                               :amount_in_cents => "150")
+    end
+   end
+   # etc
+```

data/lib/mxit_api/version.rb

@@ -1,7 +1,7 @@
 class MxitApi
   module Version
     MAJOR = 0
-    MINOR = 1
+    MINOR = 2
     PATCH = 0
     BUILD = 'pre'
 

data/lib/mxit_api.rb

@@ -5,4 +5,9 @@ require 'mxit_api/initialize'
 require 'mxit_api/profile'
 require 'mxit_api/send_invite'
 require 'mxit_api/send_message'
-require 'mxit_api/version'
+require 'mxit_api/version'
+require 'mxit_money_api/initialize'
+require 'mxit_money_api/user'
+require 'mxit_money_api/issue_money'
+
+

data/lib/mxit_money_api/initialize.rb

@@ -0,0 +1,30 @@
+class MxitMoneyApi
+
+  attr_reader :api_key, :balance
+
+  def initialize(api_key)
+    @api_key = api_key
+    balance
+  end
+
+  def self.connect(*args)
+    connection = new(*args)
+    connection.balance ? connection : nil
+  end
+
+  def balance
+    return @balance unless @balance.nil?
+    url = URI.parse('https://m2api.fireid.com/paymentsplatform/rest/v3/push/')
+    req = Net::HTTP::Get.new(url.path, 'Accept'=>'application/json')
+    req.basic_auth(api_key,"mxit_money_api")
+    http = Net::HTTP.new(url.host, url.port)
+    http.use_ssl = true
+    response = http.request(req)
+    if response.code == '200'
+      data = ActiveSupport::JSON.decode(response.body)
+      @balance = data['balance']
+    end
+    @balance
+  end
+
+end

data/lib/mxit_money_api/issue_money.rb

@@ -0,0 +1,20 @@
+class MxitMoneyApi
+
+  def issue_money(params)
+    params = Hash[params.map {|k, v| [k.to_s.camelize(:lower), v] }]
+    url = URI.parse("https://m2api.fireid.com/paymentsplatform/rest/v3/push/issue/#{params.delete('phoneNumber')}?#{params.to_query}")
+    req = Net::HTTP::Post.new(url.to_s,
+                              'Accept'=>'application/json',
+                              'Content-Type' =>'application/json')
+    req.basic_auth(api_key,"mxit_money_api".to_s)
+    http = Net::HTTP.new(url.host, url.port)
+    http.use_ssl = true
+    response = http.request(req)
+    if response.code == '200' || response.code == '401' || response.code == '500' || response.code == '400'
+      @balance = nil
+      data = ActiveSupport::JSON.decode(response.body)
+      HashWithIndifferentAccess.new(Hash[data.map {|k, v| [k.underscore, v] }])
+    end
+  end
+
+end

data/lib/mxit_money_api/user.rb

@@ -0,0 +1,17 @@
+class MxitMoneyApi
+
+  def user_info(params)
+    params.symbolize_keys!
+    url = URI.parse("https://m2api.fireid.com/paymentsplatform/rest/v3/user/#{params[:id]}?idType=#{(params[:id_type] || 'mxit_id').to_s.camelize(:lower)}")
+    req = Net::HTTP::Get.new(url.to_s, 'Accept'=>'application/json')
+    req.basic_auth(api_key,"mxit_money_api".to_s)
+    http = Net::HTTP.new(url.host, url.port)
+    http.use_ssl = true
+    response = http.request(req)
+    if response.code == '200' || response.code == '401' || response.code == '500' || response.code == '400'
+      data = ActiveSupport::JSON.decode(response.body)
+      HashWithIndifferentAccess.new(Hash[data.map {|k, v| [k.underscore, v] }])
+    end
+  end
+
+end

data/mxit_api.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = "mxit_api"
-  s.version = "0.1.0.pre"
+  s.version = "0.2.0.pre"
 
   s.required_rubygems_version = Gem::Requirement.new("> 1.3.1") if s.respond_to? :required_rubygems_version=
   s.authors = ["Grant Speelman"]
-  s.date = "2012-11-08"
+  s.date = "2013-01-09"
   s.description = "gem to use the Mxit APIs at http://dev.mxit.com/docs/ "
   s.email = "grant.speelman@unboxedconsulting.com"
   s.extra_rdoc_files = [
@@ -31,8 +31,12 @@ Gem::Specification.new do |s|
     "lib/mxit_api/send_invite.rb",
     "lib/mxit_api/send_message.rb",
     "lib/mxit_api/version.rb",
+    "lib/mxit_money_api/initialize.rb",
+    "lib/mxit_money_api/issue_money.rb",
+    "lib/mxit_money_api/user.rb",
     "mxit_api.gemspec",
     "spec/mxit_api_spec.rb",
+    "spec/mxit_money_api_spec.rb",
     "spec/spec_helper.rb"
   ]
   s.homepage = "http://github.com/unboxed/mxit_api"

data/spec/mxit_money_api_spec.rb

@@ -0,0 +1,122 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe MxitMoneyApi do
+
+  before :each do
+    token_body = %&{
+                    "balance": 5000
+                   }&
+    stub_request(:get, "https://3:mxit_money_api@m2api.fireid.com/paymentsplatform/rest/v3/push/").to_return(:status => 200, :body => token_body, :headers => {})
+  end
+
+  context "new" do
+
+    it "must post to mxit api requesting token" do
+      MxitMoneyApi.new("3")
+      assert_requested(:get, "https://3:mxit_money_api@m2api.fireid.com/paymentsplatform/rest/v3/push/",
+                       :headers => {'Accept'=>'application/json', 'User-Agent'=>'Ruby'})
+    end
+
+    it "must set the balance" do
+      connection = MxitMoneyApi.new("3")
+      connection.balance.should == 5000
+    end
+
+  end
+
+  context "connect" do
+
+    it "must return connection if has access_token" do
+      connection = mock('MxitMoneyApi', balance: "123")
+      MxitMoneyApi.should_receive(:new).with("3").and_return(connection)
+      MxitMoneyApi.connect("3").should == connection
+    end
+
+    it "wont return connection if no balance" do
+      connection = mock('MxitApi', balance: nil)
+      MxitMoneyApi.should_receive(:new).with("3").and_return(connection)
+      MxitMoneyApi.connect("3").should be_nil
+    end
+
+  end
+
+  context "user_info" do
+
+    before :each do
+      @body = %&{ "isRegistered": true,
+                 "loginName": "gbox21",
+                 "mxitId": "m40000000000",
+                 "msisdn": "27712345678"
+                }&
+      @connection = MxitMoneyApi.new("3")
+    end
+
+    it "must return a hash for search by mxitId" do
+      stub_request(:get, "https://3:mxit_money_api@m2api.fireid.com/paymentsplatform/rest/v3/user/m40000000000?idType=mxitId").
+        with(:headers => {'Accept'=>'application/json', 'User-Agent'=>'Ruby'}).
+        to_return(:status => 200, :body => @body, :headers => {})
+      profile = @connection.user_info(:id => 'm40000000000')
+      profile.should be_kind_of(Hash)
+      profile[:is_registered].should == true
+      profile[:login_name].should == "gbox21"
+      profile[:mxit_id].should == "m40000000000"
+      profile[:msisdn].should == "27712345678"
+    end
+
+    it "must return a hash for search by phoneNumber" do
+      stub_request(:get, "https://3:mxit_money_api@m2api.fireid.com/paymentsplatform/rest/v3/user/0712345678?idType=phoneNumber").
+        with(:headers => {'Accept'=>'application/json', 'User-Agent'=>'Ruby'}).
+        to_return(:status => 200, :body =>  @body, :headers => {})
+      profile = @connection.user_info(:id => '0712345678', :id_type => :phone_number)
+      profile.should be_kind_of(Hash)
+      profile[:is_registered].should == true
+      profile[:login_name].should == "gbox21"
+      profile[:mxit_id].should == "m40000000000"
+      profile[:msisdn].should == "27712345678"
+    end
+
+    it "must handle a failed response" do
+      body = %&{
+                 "errorType": "INVALID_MSISDN",
+                 "message": "The phone number is incorrect."
+                }&
+      stub_request(:get, "https://3:mxit_money_api@m2api.fireid.com/paymentsplatform/rest/v3/user/m40000000001?idType=mxitId").
+        with(:headers => {'Accept'=>'application/json', 'User-Agent'=>'Ruby'}).
+        to_return(:status => 500, :body => body, :headers => {})
+      profile = @connection.user_info(:id => 'm40000000001')
+      profile.should_not be_empty
+    end
+
+  end
+
+  context "issue_money" do
+
+    before :each do
+      @body = %&{
+                 "m2_reference": "886e797d-ff9b-4743-a6a6-908bf588b2f8"
+                }&
+      stub_request(:post, "https://3:mxit_money_api@m2api.fireid.com/paymentsplatform/rest/v3/push/issue/0761234567?amountInCents=123&merchantReference=000000001").
+        to_return(:status => 200, :body => @body, :headers => {})
+      @connection = MxitMoneyApi.new("3")
+    end
+
+    it "must make the correct api request" do
+      @connection.issue_money(:phone_number => "0761234567",
+                              :merchant_reference => "000000001",
+                              :amount_in_cents => "123")
+      assert_requested(:post, "https://3:mxit_money_api@m2api.fireid.com/paymentsplatform/rest/v3/push/issue/0761234567?amountInCents=123&merchantReference=000000001",
+                       :headers => {'Accept'=>'application/json',
+                                    'User-Agent'=>'Ruby',
+                                    'Content-Type' =>'application/json'})
+    end
+
+    it "must handle a response" do
+      profile = @connection.issue_money(:phone_number => "0761234567",
+                                        :merchant_reference => "000000001",
+                                        :amount_in_cents => "123")
+      profile.should_not be_empty
+    end
+
+  end
+
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: mxit_api
 version: !ruby/object:Gem::Version
-  version: 0.1.0.pre
+  version: 0.2.0.pre
   prerelease: 6
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-11-08 00:00:00.000000000 Z
+date: 2013-01-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -209,8 +209,12 @@ files:
 - lib/mxit_api/send_invite.rb
 - lib/mxit_api/send_message.rb
 - lib/mxit_api/version.rb
+- lib/mxit_money_api/initialize.rb
+- lib/mxit_money_api/issue_money.rb
+- lib/mxit_money_api/user.rb
 - mxit_api.gemspec
 - spec/mxit_api_spec.rb
+- spec/mxit_money_api_spec.rb
 - spec/spec_helper.rb
 homepage: http://github.com/unboxed/mxit_api
 licenses:
@@ -227,7 +231,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 3437017726523863957
+      hash: 3691744955216269910
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements: