beyonic 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: a9cb750b8209850df7f7aa7b95776d92af061fda
+  data.tar.gz: 6323d13294482469a53bccb3616b46a4b94b2be1
+SHA512:
+  metadata.gz: d6591580528bcaf8318a6b1e4dccb473a1f0754d5314d5cf2befc3811bb93155306fba56e1e7d336244c9ce0e0e9379cb028fa39396aaea8afa911ed9b091440
+  data.tar.gz: 01437d12906e27237ef5908c86655d82993d31866153f7d3644861cfaafdd8f3f55ffad923fc2732c9f695c17b12de8d7371ff6edeee910f1347997c48284201

data/.gitignore

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

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--require spec_helper

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Oleg German
+
+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,63 @@
+# Beyonic
+
+Ruby API wrapper for http://beyonic.com
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'beyonic_api', git: 'git@bitbucket.org:ogerman/beyonic_api.git'
+```
+
+And then execute:
+
+    $ bundle
+
+## Usage
+To start using API you must setup your api key
+
+```ruby
+Beyonic.api_key = "my-authorization-token"
+```
+
+Now you can create payment
+
+```ruby
+Beyonic::Payment.create(
+    phonenumber: "+256773712831",
+    amount: "100.2",
+    currency: "UGX",
+    description: "Per diem payment",
+    payment_type: "money",
+    callback_url: "https://my.website/payments/callback",
+    metadata: "{'id': '1234', 'name': 'Lucy'}"
+)
+```
+
+After successeful creation you will get object Payment with id.
+
+Also you can list all your payments or get one by id
+
+```ruby
+Beyonic::Payment.list
+Beyonic::Payment.get(123)
+```
+
+Apart from everything else, you can manage Webohooks to define URLs on your server that notifications should be sent to.
+```ruby
+#Create
+Beyonic::Webhook.create(
+    event: "payment.status.changed",
+    target: "https://my.callback.url/"
+)
+
+#Update by id
+Beyonic::Webhook.update(2, 
+    target: "https://mynew.callback.url/")
+    
+#Delete by id
+Beyonic::Webhook.delete(2)
+```
+
+You can find more detailed API description here http://support.beyonic.com/category/api/

data/Rakefile

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

data/beyonic.gemspec

@@ -0,0 +1,30 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'beyonic/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "beyonic"
+  spec.version       = Beyonic::VERSION
+  spec.authors       = ['Oleg German', 'Luke Kyohere']
+  spec.email         = ['oleg.german@gmail.com', 'luke@beyonic.com']
+  spec.summary       = %q{Ruby library for the beyonic.com api}
+  spec.description   = %q{Beyonic.com makes enterprise payments to mobile easy. Details: http://beyonic.com}
+  spec.homepage      = "http://support.beyonic.com/api/"
+  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_runtime_dependency "rest-client"
+  spec.add_runtime_dependency "oj"
+
+  spec.add_development_dependency "bundler", "~> 1.7"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "rspec-collection_matchers"
+  spec.add_development_dependency "webmock"
+  spec.add_development_dependency "simplecov"
+end

data/lib/beyonic.rb

@@ -0,0 +1,30 @@
+module Beyonic
+
+  require "rest-client"
+  require "oj"
+
+  #Fixme!  remove me after getting new cert
+  OpenSSL::SSL::VERIFY_PEER = OpenSSL::SSL::VERIFY_NONE
+
+  def self.api_key=(key)
+    @api_key = key
+  end
+
+  def self.api_key
+    @api_key
+  end
+
+  def self.api_version
+    "v1"
+  end
+
+  def self.endpoint_base
+    "https://staging.beyonic.com/api/"
+  end
+
+end
+
+require "beyonic/version"
+require "beyonic/abstract_api"
+require "beyonic/payment"
+require "beyonic/webhook"

data/lib/beyonic/abstract_api.rb

@@ -0,0 +1,88 @@
+module Beyonic::AbstractApi
+  class ApiError < StandardError
+  end
+
+  module ClassMethods
+
+    def set_endpoint_resource(resource)
+      @endpoint_url = Beyonic.endpoint_base + resource
+    end
+
+    def create(payload = {})
+      resp = RestClient.post(@endpoint_url, payload, headers)
+      self.new(Oj.load(resp))
+    rescue RestClient::BadRequest => e
+      raise ApiError.new(Oj.load(e.response.body))
+    end
+
+    def list
+      resp = RestClient.get(@endpoint_url, headers)
+      Oj.load(resp).map { |obj_attrs| self.new(obj_attrs)}
+    end
+
+    def get(id)
+      resp = RestClient.get("#{@endpoint_url}/#{id}", headers)
+      self.new(Oj.load(resp))
+    end
+
+    def update(id, payload)
+      resp = RestClient.patch("#{@endpoint_url}/#{id}", payload, headers)
+      self.new(Oj.load(resp))
+      rescue RestClient::BadRequest => e
+        raise ApiError.new(Oj.load(e.response.body))
+    end
+
+    def delete(id)
+      resp = RestClient.delete("#{@endpoint_url}/#{id}", headers)
+      return true if resp == ""
+    end
+
+    private
+
+    def headers
+      headers_hash = {}
+      headers_hash.merge!({"Authorization" => "Token #{Beyonic.api_key}"}) if Beyonic.api_key
+      headers_hash.merge!({"Beyonic-Version" => Beyonic.api_version})
+      headers_hash
+    end
+    
+  end
+  
+  module InstanceMethods
+
+    def save
+      if respond_to?(:id) && !id.nil?
+        self.class.update(id, to_h)
+      else
+        self.class.create(to_h)
+      end
+    end
+
+
+    def []=(name, value)
+      if name.to_sym == :id
+        self.id=(value)
+      else
+        super(name,value)
+      end
+    end
+    
+  end
+
+  module Initializer
+    def initialize(*args)
+      super(*args)
+      #We should define it after Object initialization
+      define_singleton_method(:id=) do |val|
+        raise "Can't change id of existing #{self.class}"
+      end
+    end
+  end
+  
+  def self.included(receiver)
+    receiver.extend ClassMethods
+    receiver.send :include, InstanceMethods
+    receiver.send :prepend, Initializer
+  end
+
+end

data/lib/beyonic/payment.rb

@@ -0,0 +1,6 @@
+require 'ostruct'
+class Beyonic::Payment < OpenStruct
+
+  include Beyonic::AbstractApi
+  set_endpoint_resource "payments"
+end

data/lib/beyonic/version.rb

@@ -0,0 +1,3 @@
+module Beyonic
+  VERSION = "0.0.1"
+end

data/lib/beyonic/webhook.rb

@@ -0,0 +1,5 @@
+require 'ostruct'
+class Beyonic::Webhook < OpenStruct
+  include Beyonic::AbstractApi
+  set_endpoint_resource "webhooks"
+end

data/spec/beyonic/payment_spec.rb

@@ -0,0 +1,223 @@
+require 'spec_helper'
+
+describe Beyonic::Payment do
+  describe ".crate" do
+    let(:payload) {
+      {
+        phonenumber: "+256773712831",
+        amount: "100.2",
+        currency: "UGX",
+        description: "Per diem payment",
+        payment_type: "money",
+        callback_url: "https://my.website/payments/callback",
+        metadata: "{'id': '1234', 'name': 'Lucy'}"
+      }
+    }
+
+    subject {
+      Beyonic.api_key = "my-authorization-token"
+      Beyonic::Payment.create(payload)
+    }
+
+    context 'Success response' do
+      before { 
+        stub_request(:post, "https://staging.beyonic.com/api/payments").to_return(
+          body: File.new('spec/examples/payments/create_response.json'))
+      }
+
+      it { 
+        is_expected.to have_requested(:post, "https://staging.beyonic.com/api/payments").with(
+            headers: {"Authorization" => "Token my-authorization-token", "Beyonic-Version" => "v1"}
+          )
+      }
+      it { is_expected.to be_an(Beyonic::Payment) }
+
+      it { is_expected.to have_attributes(id: 3607, state: 'new') }
+    end
+
+    context 'Bad request' do
+      before { 
+        stub_request(:post, "https://staging.beyonic.com/api/payments").to_return(
+          body: File.new('spec/examples/payments/create_invalid_response.json'), 
+          status: 400
+        )
+      }
+
+      subject {
+        -> {
+          Beyonic.api_key = "my-authorization-token"
+          Beyonic::Payment.create(payload)
+        }
+      }
+      it { 
+        is_expected.to raise_error(Beyonic::AbstractApi::ApiError)
+      }
+    end
+
+    context 'Unauthorized' do
+      before { 
+        stub_request(:post, "https://staging.beyonic.com/api/payments").to_return(
+          body: File.new('spec/examples/invalid_token_error.json'), 
+          status: 401
+        )
+      }
+
+      subject {
+        -> {
+          Beyonic.api_key = "my-authorization-token"
+          Beyonic::Payment.create(payload)
+        }
+      }
+      it { 
+        is_expected.to raise_error
+      }
+    end
+
+  end
+
+  describe ".list" do
+    subject {
+      Beyonic.api_key = "my-authorization-token"
+      Beyonic::Payment.list
+    }
+
+    context 'Success response' do
+      before { 
+        stub_request(:get, "https://staging.beyonic.com/api/payments").to_return(
+          body: File.new('spec/examples/payments/list_response.json'))
+      }
+
+      it { 
+        is_expected.to have_requested(:get, "https://staging.beyonic.com/api/payments").with(
+            headers: {"Authorization" => "Token my-authorization-token", "Beyonic-Version" => "v1"}
+          )
+      }
+      it { is_expected.to be_an(Array) }
+
+      it { is_expected.to all(be_an(Beyonic::Payment)) }
+    end
+
+    context 'Unauthorized' do
+      before { 
+        stub_request(:get, "https://staging.beyonic.com/api/payments").to_return(
+          body: File.new('spec/examples/invalid_token_error.json'), 
+          status: 401
+        )
+      }
+
+      subject {
+        -> {
+          Beyonic.api_key = "my-authorization-token"
+          Beyonic::Payment.list
+        }
+      }
+      it { 
+        is_expected.to raise_error
+      }
+    end
+  end
+
+  describe ".get" do
+    subject {
+      Beyonic.api_key = "my-authorization-token"
+      Beyonic::Payment.get(23)
+    }
+
+    context 'Success response' do
+      before { 
+        stub_request(:get, "https://staging.beyonic.com/api/payments/23").to_return(
+          body: File.new('spec/examples/payments/get_response.json'))
+      }
+
+      it { 
+        is_expected.to have_requested(:get, "https://staging.beyonic.com/api/payments/23").with(
+            headers: {"Authorization" => "Token my-authorization-token", "Beyonic-Version" => "v1"}
+          )
+      }
+      it { is_expected.to be_an(Beyonic::Payment) }
+
+      it { is_expected.to have_attributes(id: 23, state: 'processed_with_errors') }
+    end
+
+    context 'Unauthorized' do
+      before { 
+        stub_request(:get, "https://staging.beyonic.com/api/payments/23").to_return(
+          body: File.new('spec/examples/invalid_token_error.json'), 
+          status: 401
+        )
+      }
+
+      subject {
+        -> {
+          Beyonic.api_key = "my-authorization-token"
+          Beyonic::Payment.get(23)
+        }
+      }
+      it { 
+        is_expected.to raise_error
+      }
+    end
+
+    context 'Unauthorized' do
+      before { 
+        stub_request(:get, "https://staging.beyonic.com/api/payments/666").to_return(
+          body: File.new('spec/examples/no_permissions_error.json'), 
+          status: 403
+        )
+      }
+
+      subject {
+        -> {
+          Beyonic.api_key = "my-authorization-token"
+          Beyonic::Payment.get(666)
+        }
+      }
+      it { 
+        is_expected.to raise_error
+      }
+    end
+  end
+
+  describe "#save" do
+    context 'new object' do
+      subject { Beyonic::Payment }
+      let(:payload) {
+        {
+          phonenumber: "+256773712831",
+          amount: "100.2",
+          currency: "UGX",
+          description: "Per diem payment",
+          payment_type: "money",
+          callback_url: "https://my.website/payments/callback",
+          metadata: "{'id': '1234', 'name': 'Lucy'}"
+        }
+      } 
+
+      before {
+        allow(subject).to receive(:create)
+        subject.new(payload).save
+      }     
+
+      it { 
+        is_expected.to have_received(:create).with(payload)
+      }
+    end
+
+    context 'loaded object' do
+      subject { Beyonic::Payment }
+      before { 
+        stub_request(:get, "https://staging.beyonic.com/api/payments/23").to_return(
+          body: File.new('spec/examples/payments/get_response.json'))
+        allow(subject).to receive(:update)
+
+        temp = subject.get(23)
+        temp.description = "foo"
+        temp.save
+      }
+
+      it { 
+        is_expected.to have_received(:update).with(23, hash_including(description: "foo"))
+      }
+    end
+  end
+end