mpower 1.0.2

data/.gitignore

@@ -0,0 +1,18 @@
+*.gem
+*.rbc
+*.DS_Store
+.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 mpower_ruby.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Alfred Robert Rowe
+
+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 @@
+# MpowerRuby
+
+TODO: Write a gem description
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'mpower'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install mpower
+
+## 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/mpower/checkout/invoice.rb

@@ -0,0 +1,131 @@
+module MPower
+  module Checkout
+    class Invoice < MPower::Checkout::Core
+
+      attr_accessor :items, :total_amount, :taxes, :description, :currency, :store
+      attr_accessor :customer, :custom_data, :cancel_url, :return_url, :invoice_url, :receipt_url
+
+      def initialize
+        @items = {}
+        @taxes = {}
+        @custom_data = {}
+        @customer = {}
+        @total_amount = 0.0
+        @currency = "ghs"
+        @store = MPower::Checkout::Store
+        @return_url = @store.return_url
+        @cancel_url = @store.cancel_url
+      end
+
+      # Adds invoice items to the @items hash, the idea is to allow this function to be used in a loop
+      def add_item(name,quantity,unit_price,total_price)
+        @items.merge!({
+          :"item_#{@items.size}" => {
+            :name => name,
+            :quantity => quantity,
+            :unit_price => unit_price,
+            :total_price => total_price
+          }
+        })
+      end
+
+      # Adds invoice tax to the @taxes hash, the idea is to allow this function to be used in a loop
+      def add_tax(name,amount)
+        @taxes.merge!({
+          :"tax_#{@taxes.size}" => {
+            :name => name,
+            :amount => amount
+          }
+        })
+      end
+
+      def get_items
+        hash_to_json @items
+      end
+
+      def get_taxes
+        hash_to_json @taxes
+      end
+
+      def get_customer_info(key)
+        @customer["#{key}"]
+      end
+
+      def get_custom_data(key)
+        @custom_data["#{name}"]
+      end
+
+      def confirm(token)
+        result = http_get_request("#{MPower::Setup.checkout_confirm_base_url}#{token}");
+        if result.size > 0
+          case result['status']
+          when 'completed'
+            @status = result['status']
+            @customer = result['customer']
+            @items = result['invoice']['items']
+            @taxes = result['invoice']['taxes']
+            @description = result['invoice']['description']
+            @custom_data = result['custom_data']
+            @total_amount = result['invoice']['total_amount']
+            @receipt_url = result['receipt_url']
+            true
+          else
+            @status = result['status']
+            @items = result['invoice']['items']
+            @taxes = result['invoice']['taxes']
+            @description = result['invoice']['description']
+            @custom_data = result['custom_data']
+            @total_amount = result['invoice']['total_amount']
+            @response_text = "Invoice status is #{result['status'].upcase}"
+            false
+          end
+        else
+          @response_text = "Invoice Not Found"
+          @response_code = 1002
+          @status = MPower::FAIL
+          false
+        end
+      end
+
+      def create
+        checkout_payload = {
+          :invoice => {
+            :items => @items,
+            :taxes => @taxes,
+            :total_amount => @total_amount,
+            :description => description
+          },
+          :store => {
+            :name => @store.name,
+            :tagline => @store.tagline,
+            :postal_address => @store.postal_address,
+            :phone => @store.phone_number,
+            :logo_url => @store.logo_url,
+            :website_url => @store.website_url
+          },
+          :actions => {
+            :cancel_url => @cancel_url,
+            :return_url => @return_url
+          }
+        }
+
+        result = http_json_request(MPower::Setup.checkout_base_url,checkout_payload)
+        case result["response_code"]
+        when "00"
+          @response_text = result["response_description"]
+          @response_code = result["response_code"]
+          @invoice_url = result["response_text"]
+          @status = MPower::SUCCESS
+          true
+        else
+          @response_text = result["response_text"]
+          @response_code = result["response_code"]
+          @invoice_url = nil
+          @status = MPower::FAIL
+          false
+        end
+      end
+
+    end
+  end
+end

data/lib/mpower/checkout/store.rb

@@ -0,0 +1,31 @@
+module MPower
+  module Checkout
+    module Store
+      @@name = "Untitled Store"
+      @@tagline = "Put your online store's tagline here."
+      @@postal_address = nil
+      @@phone_number = nil
+      @@website_url = nil
+      @@logo_url = nil
+      @@cancel_url = nil
+      @@return_url = nil
+
+      def self.name=(name); @@name = name; end
+      def self.name; @@name; end
+      def self.tagline=(tagline); @@tagline = tagline; end
+      def self.tagline; @@tagline; end
+      def self.postal_address=(postal_address); @@postal_address = postal_address; end
+      def self.postal_address; @@postal_address; end
+      def self.phone_number=(phone_number); @@phone_number = phone_number; end
+      def self.phone_number; @@phone_number; end
+      def self.website_url=(website_url); @@website_url = website_url; end
+      def self.website_url; @@website_url; end
+      def self.logo_url=(logo_url); @@logo_url = logo_url; end
+      def self.logo_url; @@logo_url; end
+      def self.cancel_url=(cancel_url); @@cancel_url = cancel_url; end
+      def self.cancel_url; @@cancel_url; end
+      def self.return_url=(return_url); @@return_url = return_url; end
+      def self.return_url; @@return_url; end
+    end
+  end
+end

data/lib/mpower/checkout.rb

@@ -0,0 +1,15 @@
+module MPower
+  module Checkout
+    class Core
+      include MPower::Utilities
+
+      attr_accessor :status, :response_text, :response_code
+    end
+  end
+end
+
+%w(checkout/invoice
+  checkout/store
+).each do |lib|
+  require File.join(File.dirname(__FILE__), lib)
+end

data/lib/mpower/setup.rb

@@ -0,0 +1,34 @@
+module MPower
+  module Setup
+    @@master_key = nil
+    @@private_key = nil
+    @@public_key = nil
+    @@token = nil
+    @@mode = "test"
+
+    LIVE_CHECKOUT_INVOICE_BASE_URL = "https://app.mpowerpayments.com/api/v1/checkout-invoice/create";
+    TEST_CHECKOUT_INVOICE_BASE_URL = "https://app.mpowerpayments.com/sandbox-api/v1/checkout-invoice/create";
+    LIVE_CHECKOUT_CONFIRM_BASE_URL = "https://app.mpowerpayments.com/api/v1/checkout-invoice/confirm/";
+    TEST_CHECKOUT_CONFIRM_BASE_URL = "https://app.mpowerpayments.com/sandbox-api/v1/checkout-invoice/confirm/";
+
+    def self.master_key=(master_key); @@master_key = master_key; end
+    def self.master_key; @@master_key; end
+    def self.private_key=(private_key); @@private_key = private_key; end
+    def self.private_key; @@private_key; end
+    def self.public_key=(public_key); @@public_key = public_key; end
+    def self.public_key; @@public_key; end
+    def self.token=(token); @@token = token; end
+    def self.token; @@token; end
+
+    def self.mode=(mode); @@mode = mode; end
+    def self.mode; @@mode; end
+
+    def self.checkout_base_url
+        @@mode == "live" ? LIVE_CHECKOUT_INVOICE_BASE_URL : TEST_CHECKOUT_INVOICE_BASE_URL
+    end
+
+    def self.checkout_confirm_base_url
+        @@mode == "live" ? LIVE_CHECKOUT_CONFIRM_BASE_URL : TEST_CHECKOUT_CONFIRM_BASE_URL
+    end
+  end
+end

data/lib/mpower/utilities.rb

@@ -0,0 +1,44 @@
+module MPower
+  module Utilities
+    def http_json_request(baseurl,payload={})
+      conn = Faraday.new(:url => baseurl, :ssl => {:verify => false}) do |faraday|
+        faraday.request  :json
+        faraday.adapter  Faraday.default_adapter
+      end
+
+      result = conn.post do |req|
+        req.headers["User-Agent"] = "MPower Checkout API Ruby client v1 aka Don Nigalon"
+        req.headers['MP-Public-Key'] = MPower::Setup.public_key
+        req.headers['MP-Private-Key'] = MPower::Setup.private_key
+        req.headers['MP-Master-Key'] = MPower::Setup.master_key
+        req.headers['MP-Token'] = MPower::Setup.token
+        req.headers['MP-Mode'] = MPower::Setup.mode
+        req.body = hash_to_json payload
+      end
+      json_to_hash(result.body)
+    end
+
+    def http_get_request(baseurl)
+      conn = Faraday.new(:url => baseurl, :ssl => {:verify => false})
+
+      result = conn.get do |req|
+        req.headers["User-Agent"] = "MPower Checkout API Ruby client v1 aka Don Nigalon"
+        req.headers['MP-Public-Key'] = MPower::Setup.public_key
+        req.headers['MP-Private-Key'] = MPower::Setup.private_key
+        req.headers['MP-Master-Key'] = MPower::Setup.master_key
+        req.headers['MP-Token'] = MPower::Setup.token
+        req.headers['MP-Mode'] = MPower::Setup.mode
+      end
+      
+      json_to_hash(result.body)
+    end
+
+    def hash_to_json(params={})
+      MultiJson.dump params
+    end
+
+    def json_to_hash(params={})
+      MultiJson.load params
+    end
+  end
+end

data/lib/mpower/version.rb

@@ -0,0 +1,3 @@
+module MPower
+  VERSION = "1.0.2"
+end

data/lib/mpower.rb

@@ -0,0 +1,13 @@
+require 'multi_json'
+require 'faraday'
+require 'faraday_middleware'
+require "mpower/version"
+require "mpower/setup"
+require "mpower/utilities"
+require "mpower/checkout"
+
+module MPower
+  SUCCESS = "success"
+  FAIL = "fail"
+  PENDING = "pending"
+end

data/mpower.gemspec

@@ -0,0 +1,23 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'mpower/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "mpower"
+  gem.version       = MPower::VERSION
+  gem.authors       = ["Alfred Rowe"]
+  gem.email         = ["alfred@ncodedevlabs.com"]
+  gem.description   = %q{Ruby library for integrating with the MPower Gateway}
+  gem.summary       = %q{Ruby client bindings for the MPower API}
+  gem.homepage      = "https://github.com/nukturnal/mpower_ruby"
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+  gem.add_dependency('rest-client', '~> 1.4')
+  gem.add_dependency('multi_json', '~> 1.1')
+  gem.add_dependency('faraday')
+  gem.add_dependency('faraday_middleware')
+end

metadata

@@ -0,0 +1,123 @@
+--- !ruby/object:Gem::Specification
+name: mpower
+version: !ruby/object:Gem::Version
+  version: 1.0.2
+  prerelease: 
+platform: ruby
+authors:
+- Alfred Rowe
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-10-29 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rest-client
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.4'
+- !ruby/object:Gem::Dependency
+  name: multi_json
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.1'
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: faraday_middleware
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Ruby library for integrating with the MPower Gateway
+email:
+- alfred@ncodedevlabs.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/mpower.rb
+- lib/mpower/checkout.rb
+- lib/mpower/checkout/invoice.rb
+- lib/mpower/checkout/store.rb
+- lib/mpower/setup.rb
+- lib/mpower/utilities.rb
+- lib/mpower/version.rb
+- mpower.gemspec
+homepage: https://github.com/nukturnal/mpower_ruby
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: Ruby client bindings for the MPower API
+test_files: []
+has_rdoc: