cubits 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: f407d28f07bf303f825ebc47aea0a17fe6e22b2c
+  data.tar.gz: 7e2a552de743466e54b1cda08d01a2ae8d4e15df
+SHA512:
+  metadata.gz: e4b801db8292d8a79a7c0ff07b785708d22b2aa49c88017bd0183797157e6f5020eb406554e4bc1791abe2fd22ddaaae67d4e4e7f3907777b1e3b81862dbd23e
+  data.tar.gz: 9a830abbb493de37e1de68e142a37e8353b478d2fc6e57738a08acd05b521193f170d77d1b486291b20742768bdd4ddc82e7aa918668ce0b6569eadf8fa3dca4

data/.gitignore

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

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 Cubits.com
+
+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,112 @@
+# Cubits API client
+
+A Ruby 1.9+ client for [Cubits](https://cubits.com) Merchant API v1.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'cubits'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install cubits
+
+## Usage
+
+### Configuration
+
+First thing you have to do is to get your API token (key+secret) from Cubits  *...Merchant integration tab?..*
+
+Then, configure your Cubits client:
+```ruby
+require 'cubits'
+
+Cubits.configure(key: '***', secret: '***')
+```
+
+Now you can test your API connection:
+```ruby
+require 'cubits'
+
+Cubits.configure(key: '***', secret: '***')
+
+Cubits.available? # => true
+```
+
+### Invoices
+
+Using the `cubits` Ruby client you can create and retrieve invoices.
+
+Invoices are represented by `Cubits::Invoice` class, which is a descendant of [Hashie::Mash](https://github.com/intridea/hashie#mash),
+so it's a Hash with a method-like access to its elements:
+
+```ruby
+invoice.id # => "686e4238970a92f04f1f5a30035bf024"
+invoice.status # => "pending"
+invoice.invoice_amount # => "0.00446216"
+invoice.invoice_currency # => "BTC"
+invoice.address # => "2MwFC54RmUyHtyNcNuxtU5zW4hCGTvYuXti"
+```
+
+#### .create
+
+Creates a new invoice.
+
+For a list of accepted and returned parameters, see `POST /api/v1/invoices` page in the [Cubits Help Center](https://cubits.com/help) Developer's section.
+
+
+```ruby
+invoice = Cubits::Invoice.create(price: '1.00', currency: 'EUR')
+```
+
+Here a call to `POST /api/v1/invoices` is executed and the response is wrapped in a `Cubits::Invoice` object.
+
+
+#### .find(*id*)
+
+Retrieves an existing invoice.
+
+```ruby
+invoice = Cubits::Invoice.find("686e4238970a92f04f1f5a30035bf024")
+```
+
+Returns `Cubits::Invoice` object or `nil` if invoice was not found.
+
+
+#### #reload
+
+Reloads `Cubits::Invoice` object.
+```ruby
+invoice = Cubits::Invoice.find("686e4238970a92f04f1f5a30035bf024")
+# do some stuff...
+invoice.reload # gets the up-to-date invoice data from Cubits API
+```
+
+### Send money
+
+`Cubits.send_money` helper method allows you to send Bitcoin from your Cubits Wallet to an external Bitcoin address.
+
+#### Parameters
+name     | type    | description
+---------|---------|---------------------
+amount   | String  | Amount in BTC to be sent, decimal as a String (e.g. "0.1234000")
+address  | String  | Bitcoin address to send the amount to
+
+```ruby
+Cubits.send_money amount: '1.5000000', address: '3BnYBqPnGtRz2cfcnhxFKy3JswU3biMk5q'
+# => {"tx_ref_code"=>"64RHH"}
+```
+
+On success `.send_money` creates a transaction and returns its reference code.
+
+----
+
+
+

data/Rakefile

@@ -0,0 +1,6 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec)
+
+desc 'Run specs'
+task default: :spec

data/cubits.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'cubits/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'cubits'
+  spec.version       = Cubits::VERSION
+  spec.authors       = ['Alex Kukushkin']
+  spec.email         = ['alex.kukushkin@cubits.com']
+  spec.summary       = 'Ruby client for Cubits Merchant API'
+  spec.description   = 'Ruby client for Cubits Merchant 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_dependency 'http', '~> 0.7'
+  spec.add_dependency 'hashie', '~> 3.3'
+
+  spec.add_development_dependency 'bundler', '~> 1.7'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'pry'
+end

data/lib/cubits/connection.rb

@@ -0,0 +1,122 @@
+require 'uri'
+require 'json'
+require 'http'
+require 'openssl'
+
+module Cubits
+  class Connection
+    CONTENT_TYPE = 'application/vnd.api+json'
+
+    #
+    # Creates a new Connection object
+    #
+    # @param params [Hash]
+    # @param params[:key] [String]
+    # @param params[:secret] [String]
+    #
+    def initialize(params)
+      fail ArgumentError, 'String is expected as :key' unless params[:key].is_a?(String)
+      fail ArgumentError, 'String is expected as :secret' unless params[:secret].is_a?(String)
+      @key = params[:key]
+      @secret = params[:secret]
+    end
+
+    # Executes a GET request
+    #
+    def get(path, data = {})
+      fail ArgumentError, 'Hash is expected as request data' unless data.is_a?(Hash)
+      encoded_data = URI.encode_www_form(data)
+      request(:get, path, encoded_data)
+    end
+
+    # Executes a POST request
+    #
+    def post(path, data = {})
+      fail ArgumentError, 'Hash is expected as request data' unless data.is_a?(Hash)
+      encoded_data = data.to_json
+      request(:post, path, encoded_data)
+    end
+
+    private
+
+    # Sends a request to the API
+    #
+    def request(method, path, encoded_data)
+      url = URI.join(Cubits.base_url, path)
+      url.query = encoded_data if method == :get && !encoded_data.empty?
+      params = {}
+      http = HTTP.with(cubits_headers(path, encoded_data))
+      http = http.with('Content-Type' => CONTENT_TYPE) unless method == :get
+      params[:body] = encoded_data unless method == :get
+      Cubits.logger.debug "> #{method.to_s.upcase}: #{url}"
+      response = http.send(method, url, params)
+      Cubits.logger.debug "< #{response.code} #{response.reason}"
+      begin
+        body = JSON.parse(response.body)
+      rescue JSON::ParserError => e
+        raise ConnectionError, "Failed to parse response: #{e}"
+      end
+      return body if (200...300).include?(response.status)
+      respond_with_error(response.code, body['message'])
+    end
+
+    # Map unsuccessful HTTP response to appropriate exception and raise it
+    #
+    def respond_with_error(status, message)
+      case status
+      when 400
+        fail BadRequest, message
+      when 403
+        fail Forbidden, message
+      when 404
+        fail NotFound, message
+      when 415
+        fail UnsupportedMediaType, message
+      when 500
+        fail InternalServerError, message
+      when 400...500
+        fail ClientError, message
+      when 500...600
+        fail ServerError, message
+      else
+        fail ConnectionError, message
+      end
+    end
+
+    # Returns timestamp based nonce
+    #
+    # @return [Integer]
+    #
+    def self.nonce
+      (Time.now.to_f * 1000).to_i
+    end
+
+    # Returns complete set of cubits headers
+    #
+    def cubits_headers(path, encoded_data)
+      nonce = self.class.nonce
+      signature = sign_request(path, nonce, encoded_data)
+
+      {
+        'CUBITS_KEY' => @key,
+        'CUBITS_NONCE' => nonce,
+        'CUBITS_SIGNATURE' => signature,
+        'Accept' => CONTENT_TYPE
+      }
+    end
+
+    # Calculates request signature
+    #
+    # @param path [String]
+    # @param nonce [Integer,String]
+    # @param request_data [String]
+    #
+    def sign_request(path, nonce, request_data)
+      msg = path + nonce.to_s + OpenSSL::Digest::SHA256.hexdigest(request_data)
+      signature = OpenSSL::HMAC.hexdigest('sha512', @secret, msg)
+      Cubits.logger.debug 'sign_request: ' \
+        "path=#{path} nonce=#{nonce} request_data=#{request_data} msg=#{msg} signature=#{signature}"
+      signature
+    end
+  end # class Connection
+end # module Cubits

data/lib/cubits/errors.rb

@@ -0,0 +1,27 @@
+module Cubits
+  class ConnectionError < StandardError
+  end
+
+  # HTTP 4xxx
+  class ClientError < ConnectionError
+  end
+
+  class BadRequest < ClientError
+  end
+
+  class Forbidden < ClientError
+  end
+
+  class NotFound < ClientError
+  end
+
+  class UnsupportedMediaType < ClientError
+  end
+
+  # HTTP 5xx
+  class ServerError < ConnectionError
+  end
+
+  class InternalServerError < ServerError
+  end
+end # module Cubits

data/lib/cubits/helpers.rb

@@ -0,0 +1,35 @@
+module Cubits
+  module Helpers
+    #
+    # Runs a few calls to Cubits API and returns true if the connection
+    # to the API is configured correctly.
+    #
+    def available?
+      Cubits.connection.get('/api/v1/test', foo: 'bar')
+      Cubits.connection.post('/api/v1/test', foo: 'bar')
+      true
+    rescue StandardError
+      false
+    end
+
+    #
+    # Executes "Send money" API call.
+    # Sends Bitcoins from Cubits Wallet to external Bitcoin address.
+    #
+    # @param params [Hash]
+    # @param params[:amount] [String] Amount to be sent, decimal as a String (e.g. "0.12340000")
+    # @param params[:address] [String] Bitcoin address the amount is to be sent to
+    #
+    def send_money(params)
+      fail ArgumentError, 'Hash is expected as params' unless params.is_a?(Hash)
+      fail ArgumentError, 'String is expected as :amount' unless params[:amount].is_a?(String)
+      fail ArgumentError, 'String is expected as :address' unless params[:address].is_a?(String)
+      fail ArgumentError, 'Invalid amount format' unless params[:amount] =~ /^\d+\.\d+$/
+      fail ArgumentError, 'Invalid address format' unless params[:address] =~ /^[A-Za-z0-9]+$/
+      Cubits.connection.post(
+        '/api/v1/send_money',
+        amount: params[:amount], address: params[:address]
+      )
+    end
+  end # module Helpers
+end # module Cubits

data/lib/cubits/invoice.rb

@@ -0,0 +1,6 @@
+module Cubits
+  class Invoice < Resource
+    path '/api/v1/invoices'
+
+  end # class Invoice
+end

data/lib/cubits/resource.rb

@@ -0,0 +1,50 @@
+require 'hashie'
+
+module Cubits
+  class Resource < Hashie::Mash
+    #
+    # Sets path for the resource
+    #
+    def self.path(p)
+      @path = p
+    end
+
+    # Returns API path to resource
+    #
+    def self.path_to(resource_or_id = nil)
+      fail ArgumentError, "Resource path is not set for #{self.class.name}" unless @path
+      if resource_or_id.is_a?(Resource)
+        "#{@path}/#{resource_or_id.id}"
+      elsif resource_or_id
+        "#{@path}/#{resource_or_id}"
+      else
+        @path
+      end
+    end
+
+    # Loads resource
+    #
+    # @param id [String]
+    #
+    # @return nil if resource is not found
+    #
+    def self.find(id)
+      self.new Cubits.connection.get(path_to(id))
+    rescue NotFound
+      nil
+    end
+
+    # Reloads resource
+    #
+    def reload
+      fail "Resource #{self.class.name} does not have an id" unless self.respond_to?(:id)
+      replace(self.class.find(id))
+    end
+
+    # Creates a new resource
+    #
+    def self.create(params = {})
+      self.new Cubits.connection.post(path_to, params)
+    end
+  end # class Resource
+end # module Cubits

data/lib/cubits/version.rb

@@ -0,0 +1,3 @@
+module Cubits
+  VERSION = '0.1.0'
+end

data/lib/cubits.rb

@@ -0,0 +1,65 @@
+require 'logger'
+
+require 'cubits/version'
+require 'cubits/connection'
+require 'cubits/errors'
+require 'cubits/helpers'
+require 'cubits/resource'
+require 'cubits/invoice'
+
+module Cubits
+  extend Cubits::Helpers
+
+  DEFAULT_BASE_URL = URI.parse('https://pay.cubits.com/')
+
+  #
+  # Configure Cubits connection
+  #
+  # @param params [Hash]
+  # @param params[:key] [String] API key obtained from Cubits
+  # @param params[:secret] [String] API secret obtained from Cubits
+  #
+  def self.configure(params = {})
+    @connection = Connection.new(params)
+  end
+
+  #
+  # Returns configured Connection object
+  #
+  def self.connection
+    @connection || fail('Cubits connection is not configured')
+  end
+
+  # Returns current Logger object
+  #
+  def self.logger
+    @logger ||= Logger.new(nil)
+  end
+
+  # Sets new Logger object
+  #
+  def self.logger=(new_logger)
+    @logger = new_logger
+  end
+
+  # Returns current base API URL
+  #
+  def self.base_url
+    @base_url ||= DEFAULT_BASE_URL
+  end
+
+  # Sets new base API URL
+  #
+  # @param new_base_url [URI]
+  #
+  def self.base_url=(new_base_url)
+    fail ArgumentError, 'URI is expected as new_base_url' unless new_base_url.is_a?(URI)
+    @base_url = new_base_url
+  end
+  # Resets all internal states
+  #
+  def self.reset
+    @connection = nil
+    @logger = nil
+  end
+end # module Cubits

data/spec/lib/cubits/connection_spec.rb

@@ -0,0 +1,12 @@
+require 'spec_helper'
+
+describe Cubits::Connection do
+  let(:key) { 'blablaKEY' }
+  let(:secret) { 'blablaSECRET' }
+
+  subject { described_class.new(key: key, secret: secret) }
+
+  it { is_expected.to respond_to(:get) }
+  it { is_expected.to respond_to(:post) }
+
+end # describe Cubits::Connection

data/spec/lib/cubits_spec.rb

@@ -0,0 +1,41 @@
+require 'spec_helper'
+
+describe Cubits do
+  let(:key) { 'blablakey' }
+  let(:secret) { 'blablasecret' }
+
+  context '.configure' do
+    it 'fails if key is missing' do
+      expect { Cubits.configure(secret: secret) }.to raise_error
+    end
+
+    it 'fails if secret is missing' do
+      expect { Cubits.configure(key: key) }.to raise_error
+    end
+
+    it 'runs without errors if key and secret are present' do
+      expect { Cubits.configure(key: key, secret: secret) }.to_not raise_error
+    end
+  end # .configure
+
+  context '.connection' do
+    subject { Cubits.connection }
+
+    it 'fails when connection is not configured' do
+      expect { subject }.to raise_error
+    end
+
+    it 'returns Connection object when connection is configured' do
+      Cubits.configure(key: key, secret: secret)
+      expect { subject }.to_not raise_error
+      expect(subject).to be_a Cubits::Connection
+    end
+  end # .connection
+
+  context '.logger' do
+    subject { Cubits.logger }
+
+    it { is_expected.to be_a Logger }
+  end # .logger
+
+end # describe Cubits

data/spec/spec_helper.rb

@@ -0,0 +1,15 @@
+require 'bundler/setup'
+Bundler.setup
+
+require 'cubits'
+
+RSpec.configure do |config|
+  config.expect_with :rspec do |c|
+    c.syntax = :expect
+  end
+
+  config.after do
+    Cubits.reset
+  end
+end
+

metadata

@@ -0,0 +1,147 @@
+--- !ruby/object:Gem::Specification
+name: cubits
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Alex Kukushkin
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-01-09 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: http
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.7'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.7'
+- !ruby/object:Gem::Dependency
+  name: hashie
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.3'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !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: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.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: Ruby client for Cubits Merchant API
+email:
+- alex.kukushkin@cubits.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- cubits.gemspec
+- lib/cubits.rb
+- lib/cubits/connection.rb
+- lib/cubits/errors.rb
+- lib/cubits/helpers.rb
+- lib/cubits/invoice.rb
+- lib/cubits/resource.rb
+- lib/cubits/version.rb
+- spec/lib/cubits/connection_spec.rb
+- spec/lib/cubits_spec.rb
+- spec/spec_helper.rb
+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 client for Cubits Merchant API
+test_files:
+- spec/lib/cubits/connection_spec.rb
+- spec/lib/cubits_spec.rb
+- spec/spec_helper.rb