moolah-ruby 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 1142bc0d9812c9f34112ac4f4829e08714b9d792
+  data.tar.gz: 6acd37ef8adec903a729796629bf0c65d9faa21d
+SHA512:
+  metadata.gz: 73e3cbcf89ccb42c6b320e772621382ae5fa44b3ec39d61fab05ffbbcd31336909c0ec710683193b2bdb408186ad20433d037bddd01779339bed3399db6745d0
+  data.tar.gz: 7eb7f7cb61f107e0a0b36f1e622ef0d169f726ff400fbb61ac46c5aa2e9ceb236b42d1c69b6762f1af8b1a943e85885395c3202aef15d8acc5491a5d63a19b2f

data/.gitignore

@@ -0,0 +1,21 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/.travis.yml

@@ -0,0 +1,9 @@
+language: ruby
+rvm:
+  - 1.9.3
+  - 2.0.0
+  - 2.1.1
+  - jruby-19mode # JRuby in 1.9 mode
+  - rbx-19mode
+# uncomment this line if your project needs to run something other than `rake`:
+script: bundle exec rspec spec

data/Gemfile

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

data/Gemfile.lock

@@ -0,0 +1,35 @@
+PATH
+  remote: .
+  specs:
+    moolah-ruby (0.0.1)
+      faraday (~> 0.9.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    diff-lcs (1.2.5)
+    faraday (0.9.0)
+      multipart-post (>= 1.2, < 3)
+    multipart-post (2.0.0)
+    rake (10.1.1)
+    rspec (3.0.0)
+      rspec-core (~> 3.0.0)
+      rspec-expectations (~> 3.0.0)
+      rspec-mocks (~> 3.0.0)
+    rspec-core (3.0.3)
+      rspec-support (~> 3.0.0)
+    rspec-expectations (3.0.3)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.0.0)
+    rspec-mocks (3.0.3)
+      rspec-support (~> 3.0.0)
+    rspec-support (3.0.3)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.6)
+  moolah-ruby!
+  rake
+  rspec (~> 3.0.0)

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 TM Lee
+
+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,71 @@
+[![Build Status](https://travis-ci.org/coingecko/moolah-ruby.png)](https://travis-ci.org/coingecko/moolah-ruby)
+
+# Moolah::Ruby
+
+Wrapper API for Moolah's Transaction API (v2)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```bash
+gem 'moolah-ruby'
+```
+
+And then execute:
+
+```bash
+$ bundle
+```
+
+Or install it yourself as:
+
+```bash
+$ gem install moolah-ruby
+```
+
+## Usage
+
+Configuration:
+```ruby
+require 'moolah'
+
+Moolah.configure do |config|
+  config.api_key = ENV['API_KEY']
+  config.api_secret = ENV['API_SECRET'] # necessary for IPN response
+  # config.endpoint = "https://api.moolah.io/v2"
+end
+```
+
+Create a transaction:
+```ruby
+moolah_client = Moolah::Client.new
+
+# No IPN Response
+response = moolah_client.create_transaction(coin: "bitcoin", currency: "USD", amount: "20", product: "Coingecko Pro")
+
+# IPN Response
+response = moolah_client.create_transaction(coin: "bitcoin", currency: "USD", amount: "20", product: "Coingecko Pro", ipn: "www.example.com/processed_payment", ipn_extra: "{ user_id: 1 }")
+
+response[:status] # "success"
+response[:guid] # "1234-1234-1234-1234"
+response[:address] # "abcdefghijklmnopqrstuvwxyz"
+# etc.
+```
+
+Query a transaction:
+```ruby
+query_result = moolah_client.query_transaction(guid:"1234-1234-1234-1234")
+
+query_result[:status] # "success"
+query_result[:transaction][:tx][:coin] # "bitcoin"
+# etc.
+```
+
+## Contributing
+
+1. Fork it ( https://github.com/coingecko/moolah-ruby/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

data/Rakefile

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

data/lib/moolah.rb

@@ -0,0 +1,7 @@
+require 'moolah/version'
+require 'moolah/configuration'
+require 'moolah/client'
+
+module Moolah
+  extend Configuration
+end

data/lib/moolah/client.rb

@@ -0,0 +1,72 @@
+require 'moolah/version'
+require 'faraday'
+require 'json'
+
+module Moolah
+  class Client
+    CREATE_TRANSACTION_ACTION = "/v2/private/merchant/create"
+    QUERY_TRANSACTION_ACTION = "/v2/private/merchant/status"
+
+    def initialize
+      # Check for API key
+      raise ArgumentError, "API Key is not set!" unless Moolah.api_key
+    end
+
+    def create_transaction(transaction_params = {})
+      coin = transaction_params[:coin] || transaction_params["coin"]
+      currency = transaction_params[:currency] || transaction_params["currency"]
+      amount = transaction_params[:amount] || transaction_params["amount"]
+      product = transaction_params[:product] || transaction_params["product"]
+
+      # Check all parameters present
+      raise ArgumentError, "Missing transaction parameter(s)" unless coin && currency && amount && product
+
+      request_body = { coin: coin, currency: currency, amount: amount, product: product, apiKey: Moolah.api_key }
+
+      ipn = transaction_params[:ipn] || transaction_params["ipn"]
+      if ipn
+        ipn_extra = transaction_params[:ipn_extra] || transaction_params["ipn_extra"]
+        request_body[:ipn] = ipn 
+        request_body[:ipn_extra] = ipn_extra
+        request_body[:apiSecret] = Moolah.api_secret
+      end
+
+      faraday_response = connection.post do |request|
+        request.url CREATE_TRANSACTION_ACTION
+        request.body = request_body
+      end
+
+      json_response = JSON.parse(faraday_response.body)
+      symbolize_keys(json_response)
+    end
+
+    def query_transaction(params = {})
+      guid = params[:guid] || params["guid"]
+
+      request_body = { guid: guid, apiKey: Moolah.api_key }
+
+      faraday_response = connection.post do |request|
+        request.url QUERY_TRANSACTION_ACTION
+        request.body = request_body
+      end
+
+      json_response = JSON.parse(faraday_response.body)
+      symbolize_keys(json_response)
+    end
+
+    # Connection method for ease of stubbing
+    def connection
+      @connection ||= Faraday.new(url: Moolah.endpoint)
+    end
+
+    def symbolize_keys(hash)
+      return hash unless hash.is_a?(Hash)
+
+      symbolized_hash = hash.inject({}) do |memo, (k,v)|
+        memo[k.to_sym] = symbolize_keys(v)
+        memo
+      end
+      symbolized_hash
+    end
+  end
+end

data/lib/moolah/configuration.rb

@@ -0,0 +1,27 @@
+require 'moolah/version'
+
+module Moolah
+  module Configuration
+    DEFAULT_ENDPOINT = "https://api.moolah.io"
+    DEFAULT_API_KEY = nil
+    DEFAULT_API_SECRET = nil
+
+    attr_accessor :api_key, :api_secret, :ipn, :endpoint
+
+    # When extended, call reset to set variable values to defaults
+    def self.extended(mod)
+      mod.reset
+    end
+
+    def reset
+      self.api_key = DEFAULT_API_KEY
+      self.api_secret = DEFAULT_API_SECRET
+      self.endpoint = DEFAULT_ENDPOINT
+    end
+
+    def configure
+      yield self
+    end
+
+  end
+end

data/lib/moolah/version.rb

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

data/moolah-ruby.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'moolah/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "moolah-ruby"
+  spec.version       = Moolah::VERSION
+  spec.authors       = ["TM Lee"]
+  spec.email         = ["tm89lee@gmail.com"]
+  spec.summary       = %q{Ruby wrapper for the Moolah.io Transaction API}
+  spec.description   = %q{Ruby wrapper for the Moolah.io Transaction API}
+  spec.homepage      = ""
+  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 "faraday", "~> 0.9.0"
+
+  spec.add_development_dependency "bundler", "~> 1.6"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec", "~> 3.0.0"
+end

data/spec/client_spec.rb

@@ -0,0 +1,157 @@
+require 'moolah'
+
+describe Moolah::Client do
+  let(:request_stubs) { Faraday::Adapter::Test::Stubs.new }
+  let (:test_connection) do
+    Faraday.new do |builder|
+      builder.adapter :test, request_stubs
+    end
+  end
+  let(:client) { Moolah::Client.new }
+
+  describe ".initialize" do
+    it "complains when API key is not configured" do
+      expect { Moolah::Client.new }.to raise_error(ArgumentError)
+    end
+
+    context "with API key" do
+      before do
+        allow(Moolah).to receive(:api_key).and_return("1234567890")
+      end
+
+      it "should not complain if API key is given" do
+        expect(Moolah::api_key).to eq("1234567890")
+        expect { Moolah::Client.new }.not_to raise_error
+      end
+    end
+  end
+
+  describe "#create_transaction" do
+    let(:action_path) { "/v2/private/merchant/create" }
+    let(:transaction_params) { { coin: "dogecoin", amount: "20", currency: "USD", product: "Coingecko Pro" } }
+
+    # Provide API Key first
+    before do
+      allow(Moolah).to receive(:api_key).and_return("1234567890")
+      allow(Moolah).to receive(:api_secret).and_return("secret")
+    end
+
+    shared_examples :success_transaction do
+      it { expect(result[:status]).to eq("success") }
+      it { expect(result[:guid]).to eq("a4dc89fcc-8ad-3f4c1bf529-6396c1acc4-") }
+      it { expect(result[:address]).to eq("DS6frMZR5jFVEf9V6pBi9qtcVJa2JX5ewR") }
+      it { expect(result[:url]).to eq("https://pay.moolah.io/a4dc89fcc-8ad-3f4c1bf529-6396c1acc4-") }
+      it { expect(result[:coin]).to eq("dogecoin") }
+      it { expect(result[:amount]).to eq("121526.39285714") }
+      it { expect(result[:timestamp]).to eq(1407579569) }
+    end
+
+    shared_examples :failure_transaction do
+      it { expect(result[:status]).to eq("failure") }
+      it { expect(result[:guid]).to eq(nil) }
+      it { expect(result[:address]).to eq(nil) }
+      it { expect(result[:url]).to eq(nil) }
+      it { expect(result[:coin]).to eq(nil) }
+      it { expect(result[:amount]).to eq(nil) }
+      it { expect(result[:timestamp]).to eq(nil) }
+    end
+
+    context "incomplete transaction parameters" do
+      let(:client) { Moolah::Client.new }
+      let(:incomplete_transaction_params) { { coin: "dogecoin", amount: "20", currency: "USD" } }
+
+      it "throws ArgumentError" do
+        expect { client.create_transaction(incomplete_transaction_params) }.to raise_error(ArgumentError)
+      end
+    end
+
+    context "successful transaction" do
+      context "without optional ipn & ipn_extra parameter" do
+        before do
+          allow(client).to receive(:connection).and_return(test_connection)
+          request_stubs.post(action_path) { |env| [ 200, {}, json_response ] }
+        end
+        let(:json_response) { '{"status":"success","guid":"a4dc89fcc-8ad-3f4c1bf529-6396c1acc4-","url":"https:\/\/pay.moolah.io\/a4dc89fcc-8ad-3f4c1bf529-6396c1acc4-","coin":"dogecoin","amount":"121526.39285714","address":"DS6frMZR5jFVEf9V6pBi9qtcVJa2JX5ewR","timestamp":1407579569}' }
+
+        context "allows transaction params to be given as argument" do
+          let(:result) { client.create_transaction transaction_params }
+          it_behaves_like :success_transaction
+        end
+      end
+
+      context "with optional ipn & ipn_extra parameter" do
+        before do
+          allow(client).to receive(:connection).and_return(test_connection)
+          request_stubs.post(action_path) { |env| [ 200, {}, json_response ] }
+        end
+        let(:json_response) { '{"status":"success","guid":"a4dc89fcc-8ad-3f4c1bf529-6396c1acc4-","url":"https:\/\/pay.moolah.io\/a4dc89fcc-8ad-3f4c1bf529-6396c1acc4-","coin":"dogecoin","amount":"121526.39285714","address":"DS6frMZR5jFVEf9V6pBi9qtcVJa2JX5ewR","timestamp":1407579569}' }
+        let(:transaction_params_with_ipn) { { coin: "dogecoin", amount: "20", currency: "USD", product: "Coingecko Pro", ipn: "www.example.com/processed_payment", ipn_extra: "extrastuff" } }
+
+        let(:result) { client.create_transaction transaction_params_with_ipn }
+        it_behaves_like :success_transaction
+      end
+    end
+
+    context "failure transaction" do
+      before do
+        allow(client).to receive(:connection).and_return(test_connection)
+        request_stubs.post(action_path) { |env| [ 200, {}, json_response ] }
+      end
+      let(:json_response) { '{"status":"failure"}' }
+
+      let(:result) { client.create_transaction transaction_params }
+      it_behaves_like :failure_transaction
+    end
+  end
+
+  describe "#query_transaction" do
+    let(:action_path) { "/v2/private/merchant/status" }
+    before do
+      allow(Moolah).to receive(:api_key).and_return("1234567890")
+    end
+
+    context "transaction does not exist" do
+      before do
+        allow(client).to receive(:connection).and_return(test_connection)
+        request_stubs.post(action_path) { |env| [ 200, {}, json_response ] }
+      end
+      let(:json_response) { '{ "status": "failure", "reason": "No such transaction." }' }
+
+      it "returns a symbolized has of the json response" do
+        result = client.query_transaction(guid:"1234-1234-1234")
+        expect(result[:status]).to eq("failure")
+        expect(result[:reason]).to eq("No such transaction.")
+      end
+    end
+
+    context "transaction exists" do
+      before do
+        allow(client).to receive(:connection).and_return(test_connection)
+        request_stubs.post(action_path) { |env| [ 200, {}, json_response ] }
+      end
+      let(:json_response) { '{
+        "status": "success",
+        "transaction": {
+          "tx": {
+              "amount": "26651.62068965",
+              "coin": "dogecoin",
+              "guid": "692-6c-e5fa17a37-4baa72bf7c5-78d88d6",
+              "status": "cancelled",
+              "tx": "-1"
+          }
+        }
+      }' }
+
+      it "returns a symbolized has of the json response" do
+        result = client.query_transaction({api_key: "1234567890", guid:"1234-1234-1234"})
+        expect(result[:status]).to eq("success")
+        expect(result[:transaction][:tx][:amount]).to eq("26651.62068965")
+        expect(result[:transaction][:tx][:coin]).to eq("dogecoin")
+        expect(result[:transaction][:tx][:guid]).to eq("692-6c-e5fa17a37-4baa72bf7c5-78d88d6")
+        expect(result[:transaction][:tx][:status]).to eq("cancelled")
+        expect(result[:transaction][:tx][:tx]).to eq("-1")
+      end
+    end
+  end
+
+end

data/spec/configuration_spec.rb

@@ -0,0 +1,29 @@
+require 'moolah'
+
+describe Moolah do
+  describe ".api_key" do
+    it "has default values" do
+      expect(Moolah.send(:api_key)).to eq(nil)
+      expect(Moolah.send(:api_secret)).to eq(nil)
+      expect(Moolah.send(:endpoint)).to eq("https://api.moolah.io")
+    end
+  end
+
+  describe ".configure" do
+    it "allows configuration via block" do
+      sample_api_key = "1234567890"
+      sample_api_secret = "secret"
+      sample_endpoint = "http://example.com"
+
+      Moolah.configure do |config|
+        config.api_key = sample_api_key
+        config.api_secret = sample_api_secret
+        config.endpoint = sample_endpoint
+      end
+
+      expect(Moolah.api_key).to eq(sample_api_key)
+      expect(Moolah.api_secret).to eq(sample_api_secret)
+      expect(Moolah.endpoint).to eq(sample_endpoint)
+    end
+  end
+end

metadata

@@ -0,0 +1,117 @@
+--- !ruby/object:Gem::Specification
+name: moolah-ruby
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- TM Lee
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-08-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.0
+- !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: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+description: Ruby wrapper for the Moolah.io Transaction API
+email:
+- tm89lee@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/moolah.rb
+- lib/moolah/client.rb
+- lib/moolah/configuration.rb
+- lib/moolah/version.rb
+- moolah-ruby.gemspec
+- spec/client_spec.rb
+- spec/configuration_spec.rb
+- travistest
+homepage: ''
+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.2.2
+signing_key: 
+specification_version: 4
+summary: Ruby wrapper for the Moolah.io Transaction API
+test_files:
+- spec/client_spec.rb
+- spec/configuration_spec.rb