cubits 0.1.0 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f407d28f07bf303f825ebc47aea0a17fe6e22b2c
-  data.tar.gz: 7e2a552de743466e54b1cda08d01a2ae8d4e15df
+  metadata.gz: 3f20d1982b3ef43be0e3b9b8cbc9fea14c1cd44f
+  data.tar.gz: 193e702ea136342137d5c73f204e0135399051cc
 SHA512:
-  metadata.gz: e4b801db8292d8a79a7c0ff07b785708d22b2aa49c88017bd0183797157e6f5020eb406554e4bc1791abe2fd22ddaaae67d4e4e7f3907777b1e3b81862dbd23e
-  data.tar.gz: 9a830abbb493de37e1de68e142a37e8353b478d2fc6e57738a08acd05b521193f170d77d1b486291b20742768bdd4ddc82e7aa918668ce0b6569eadf8fa3dca4
+  metadata.gz: 21fc0a0189fa63b53c738a41252700a3a0075e2097706099ff6056614be1be2564f038281cd8a4e164897544b21b64dc6e7d17c614e54d0c1d8f9a53c53aa0f2
+  data.tar.gz: fce9506b0b8c7d36b367f44505031981679727b0a533f8cfd633d7eafcc6bc10b58392efcce75a9f786fd09684ca11e9188b14fb9a8d4b84d8e702aee26c8613

data/CHANGES.md

@@ -0,0 +1,21 @@
+# 0.2.1
+
+Minor fixes to README.
+
+# 0.2.0
+
+Implemented new API calls:
+
+* Retrieving a list of accounts: `Cubits::Account.all`
+* Get a quote for an operation: `Cubits::Quote.create(...)`
+* Buy bitcoins using funds in a Cubits account: `Cubits.buy(...)`
+* Sell bitcoins and credit funds to a Cubits account: `Cubits.sell(...)`
+
+# 0.1.0
+
+Initial release.
+
+* Configuring connection
+* Testing connection: `Cubits.available?`
+* Creating, retrieving invoices: `Cubits::Invoice`
+* Send bitcoins to a bitcoin address: `Cubits.send_money(...)`

data/README.md

@@ -2,7 +2,7 @@
 
 A Ruby 1.9+ client for [Cubits](https://cubits.com) Merchant API v1.
 
-## Installation
+# Installation
 
 Add this line to your application's Gemfile:
 
@@ -18,11 +18,11 @@ Or install it yourself as:
 
     $ gem install cubits
 
-## Usage
+# Usage
 
-### Configuration
+## Configuration
 
-First thing you have to do is to get your API token (key+secret) from Cubits  *...Merchant integration tab?..*
+First thing you have to do is to generate your API token (key+secret) from your [Cubits Pay](https://cubits.com/merchant) account in the API integration section.
 
 Then, configure your Cubits client:
 ```ruby
@@ -40,26 +40,25 @@ Cubits.configure(key: '***', secret: '***')
 Cubits.available? # => true
 ```
 
-### Invoices
+## 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:
+Invoices are represented by the `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"
+invoice.address # => "3QJmV3qfvL9SuYo34YihAf3sRCW3qSinyC"
 ```
 
 #### .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.
+For a list of accepted and returned parameters, see the `POST /api/v1/invoices` page in the [Cubits Help Center](https://cubits.com/help) Developer's section.
 
 
 ```ruby
@@ -77,7 +76,7 @@ Retrieves an existing invoice.
 invoice = Cubits::Invoice.find("686e4238970a92f04f1f5a30035bf024")
 ```
 
-Returns `Cubits::Invoice` object or `nil` if invoice was not found.
+Returns `Cubits::Invoice` object or `nil` if the specified invoice was not found.
 
 
 #### #reload
@@ -86,10 +85,104 @@ 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
+invoice.reload # gets the up-to-date invoice data from the Cubits API
 ```
 
-### Send money
+## Accounts
+
+Your Cubits accounts are represented by the `Cubits::Account` 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
+account = Cubits::Account.all.first
+
+account.currency # => "EUR"
+account.balance # => "125.00"
+```
+
+#### .all
+
+Retrieves a list of accounts.
+
+Returns `Array` of `Cubits::Account` objects.
+
+```ruby
+Cubits::Account.all # => [{ currency: 'EUR', balance: '125.00' }, ...]
+```
+
+## Quotes
+
+Requests a quote for a *"buy"* or *"sell"* operation.
+
+Quotes contain information about the current Cubits exchange rate for a certain operation type of a certain amount and can serve as an estimation for subsequent buy or sell requests.
+
+#### .create
+Creates a new quote.
+
+For a list of accepted and returned parameters, see the `POST /api/v1/quotes` page in the [Cubits Help Center](https://cubits.com/help) Developer's section.
+
+
+```ruby
+quote = Cubits::Quote.create(
+  operation: 'buy',
+  sender: {
+    currency: 'EUR'
+  },
+  receiver: {
+    currency: 'BTC',
+    amount: '1.0'
+  }
+)
+
+quote.sender # => {"currency"=>"EUR", "amount"=>"172.81"}
+```
+
+Here a call to `POST /api/v1/quotes` is executed and the response is wrapped in a `Cubits::Quote` object.
+
+
+## Buy bitcoins
+
+`Cubits.buy` helper method creates a transaction to buy bitcoins using funds from your Cubits account. Bought bitcoins will be credited to your Cubits wallet.
+
+The exact exchange rate will be calculated at the transaction execution time.
+
+#### Parameters
+Attribute   | Data type   | Description
+------------|-------------|--------------
+sender      | Hash        | Sender attributes define the spending part of the transaction
+sender[:currency] | String | [ISO 4217](http://en.wikipedia.org/wiki/ISO_4217#Active_codes) code of the currency that you want to spend (e.g. "EUR")
+sender[:amount] | String   | Amount in specified currency to be spent, decimal number as a string (e.g. "12.50")
+
+```ruby
+Cubits.buy sender: { currency: 'EUR', amount: '150.00' }
+# => {"tx_ref_code"=>"RNXH3"}
+```
+
+On success, `.buy` creates a transaction and returns its reference code.
+
+
+## Sell bitcoins
+
+`Cubits.sell` helper method creates a transaction to sell bitcoins from your Cubits wallet and receive the according amount in the specified fiat currency. Fiat funds will be credited to your Cubits cash account.
+
+The exact exchange rate will be calculated at the transaction execution time.
+
+#### Parameters
+Attribute   | Data type   | Description
+------------|-------------|--------------
+sender      | Hash        | Sender attributes define the spending part of the transaction
+sender[:amount] | String   | Amount in BTC to be spent, decimal number as a string (e.g. "0.01250000")
+receiver    | Hash        | Receiver attributes define the receiving part of the transaction
+receiver[:currency] | String | ISO 4217](http://en.wikipedia.org/wiki/ISO_4217#Active_codes) code of the currency that you want to receive (e.g. "EUR")
+
+
+```ruby
+Cubits.sell sender: { amount: '0.45000000' }, receiver: { currency: 'EUR' }
+# => {"tx_ref_code"=>"4XRX3"}
+```
+
+On success, `.sell` creates a transaction and returns its reference code.
+
+
+## Send money
 
 `Cubits.send_money` helper method allows you to send Bitcoin from your Cubits Wallet to an external Bitcoin address.
 

data/cubits.gemspec

@@ -10,7 +10,7 @@ Gem::Specification.new do |spec|
   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.homepage      = 'https://github.com/cubits/cubits-ruby'
   spec.license       = 'MIT'
 
   spec.files         = `git ls-files -z`.split("\x0")

data/lib/cubits/account.rb

@@ -0,0 +1,6 @@
+module Cubits
+  class Account < Resource
+    path '/api/v1/accounts'
+    expose_methods :all
+  end # class Account
+end

data/lib/cubits/helpers.rb

@@ -31,5 +31,66 @@ module Cubits
         amount: params[:amount], address: params[:address]
       )
     end
+
+    # Executes "Buy bitcoins" API call.
+    # Buy Bitcoins using funds in a Cubits account. Bought Bitcoins will be credited
+    # to your Cubits Wallet.
+    #
+    # @param params [Hash]
+    # @param params[:sender] [Hash] Sender attributes define spending part of transaction
+    # @param params[:sender][:currency] [String] ISO 4217 code of the currency, that you want
+    #                                            to spend (e.g. "EUR")
+    # @param params[:sender][:amount] [String] Amount in specified currency to be spent,
+    #                                          decimal number as a String (e.g. "12.50")
+    #
+    def buy(params)
+      fail ArgumentError, 'Hash is expected as params' unless params.is_a?(Hash)
+      fail ArgumentError, 'Hash is expected as :sender' unless params[:sender].is_a?(Hash)
+      sender = params[:sender]
+      fail ArgumentError, 'String is expected as sender[:currency]' unless sender[:currency].is_a?(String)
+      fail ArgumentError, 'String is expected as sender[:amount]' unless sender[:amount].is_a?(String)
+      fail ArgumentError, 'Invalid amount format' unless sender[:amount] =~ /^\d+\.\d+$/
+      Cubits.connection.post(
+        '/api/v1/buy',
+        sender: {
+          currency: sender[:currency],
+          amount: sender[:amount]
+        }
+      )
+    end
+
+
+    # Executes "Sell bitcoins" API call.
+    #
+    # Creates a transaction to sell bitcoins from your Cubits wallet and receive amount
+    # in specified fiat currency. Fiat funds will be credited to your Cubits account.
+    #
+    # @param params [Hash]
+    # @param params[:sender] [Hash] Sender attributes define spending part of transaction
+    # @param params[:sender][:amount] [String] Amount in bitcoins to be spent,
+    #                                          decimal number as a String (e.g. "0.01250000")
+    # @param params[:receiver] [Hash] Receiver attributes define receiving part of transaction
+    # @param params[:receiver][:currency] [String] ISO 4217 code of the currency, that you want
+    #                                            to receive (e.g. "EUR")
+    #
+    def sell(params)
+      fail ArgumentError, 'Hash is expected as params' unless params.is_a?(Hash)
+      fail ArgumentError, 'Hash is expected as :sender' unless params[:sender].is_a?(Hash)
+      sender = params[:sender]
+      fail ArgumentError, 'String is expected as sender[:amount]' unless sender[:amount].is_a?(String)
+      fail ArgumentError, 'Invalid amount format' unless sender[:amount] =~ /^\d+\.\d+$/
+      fail ArgumentError, 'Hash is expected as :receiver' unless params[:receiver].is_a?(Hash)
+      receiver = params[:receiver]
+      fail ArgumentError, 'String is expected as receiver[:currency]' unless receiver[:currency].is_a?(String)
+      Cubits.connection.post(
+        '/api/v1/sell',
+        sender: {
+          amount: sender[:amount]
+        },
+        receiver: {
+          currency: receiver[:currency]
+        }
+      )
+    end
   end # module Helpers
 end # module Cubits

data/lib/cubits/invoice.rb

@@ -1,6 +1,6 @@
 module Cubits
   class Invoice < Resource
     path '/api/v1/invoices'
-
+    expose_methods :create, :find, :reload
   end # class Invoice
 end

data/lib/cubits/quote.rb

@@ -0,0 +1,7 @@
+module Cubits
+  class Quote < Resource
+    path '/api/v1/quotes'
+
+    expose_methods :create
+  end # class Quote
+end

data/lib/cubits/resource.rb

@@ -9,6 +9,24 @@ module Cubits
       @path = p
     end
 
+    # By convention collection name for the resource is the last part of the path
+    #
+    def self.collection_name
+      @path.split('/').last
+    end
+
+    # Sets exposed methods for the resource
+    #
+    def self.expose_methods(*args)
+      @exposed_methods = args
+    end
+
+    # @return true if the method is exposed by this resource
+    #
+    def self.exposed_method?(method_name)
+      (@exposed_methods || []).include?(method_name)
+    end
+
     # Returns API path to resource
     #
     def self.path_to(resource_or_id = nil)
@@ -22,6 +40,17 @@ module Cubits
       end
     end
 
+    # Loads collection of resources
+    #
+    # @return [Array<Resource>]
+    #
+    def self.all
+      fail NoMethodError, "Resource #{name} does not expose .all" unless exposed_method?(:all)
+      Cubits.connection.get(path_to)[collection_name].map { |r| new r }
+    rescue NotFound
+      nil
+    end
+
     # Loads resource
     #
     # @param id [String]
@@ -29,7 +58,8 @@ module Cubits
     # @return nil if resource is not found
     #
     def self.find(id)
-      self.new Cubits.connection.get(path_to(id))
+      fail NoMethodError, "Resource #{name} does not expose .find" unless exposed_method?(:find)
+      new Cubits.connection.get(path_to(id))
     rescue NotFound
       nil
     end
@@ -37,6 +67,9 @@ module Cubits
     # Reloads resource
     #
     def reload
+      unless self.class.exposed_method?(:reload)
+        fail NoMethodError, "Resource #{self.class.name} does not expose #reload"
+      end
       fail "Resource #{self.class.name} does not have an id" unless self.respond_to?(:id)
       replace(self.class.find(id))
     end
@@ -44,7 +77,8 @@ module Cubits
     # Creates a new resource
     #
     def self.create(params = {})
-      self.new Cubits.connection.post(path_to, params)
+      fail NoMethodError, "Resource #{name} does not expose .create" unless exposed_method?(:create)
+      new Cubits.connection.post(path_to, params)
     end
   end # class Resource
 end # module Cubits

data/lib/cubits/version.rb

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

data/lib/cubits.rb

@@ -6,6 +6,8 @@ require 'cubits/errors'
 require 'cubits/helpers'
 require 'cubits/resource'
 require 'cubits/invoice'
+require 'cubits/account'
+require 'cubits/quote'
 
 module Cubits
   extend Cubits::Helpers
@@ -50,9 +52,10 @@ module Cubits
 
   # Sets new base API URL
   #
-  # @param new_base_url [URI]
+  # @param new_base_url [URI,String]
   #
   def self.base_url=(new_base_url)
+    new_base_url = URI.parse(new_base_url) if new_base_url.is_a?(String)
     fail ArgumentError, 'URI is expected as new_base_url' unless new_base_url.is_a?(URI)
     @base_url = new_base_url
   end

data/spec/lib/cubits/account_spec.rb

@@ -0,0 +1,9 @@
+require 'spec_helper'
+
+describe Cubits::Account do
+  context 'class methods,' do
+    subject { described_class }
+
+    it { is_expected.to respond_to(:all) }
+  end # class methods
+end # describe Cubits::Account

data/spec/lib/cubits/helpers_spec.rb

@@ -0,0 +1,12 @@
+require 'spec_helper'
+
+describe Cubits do
+  context 'class methods,' do
+    subject { described_class }
+
+    it { is_expected.to respond_to(:available?) }
+    it { is_expected.to respond_to(:send_money) }
+    it { is_expected.to respond_to(:buy) }
+    it { is_expected.to respond_to(:sell) }
+  end # class methods
+end # describe Cubits::Account

data/spec/lib/cubits/invoice_spec.rb

@@ -0,0 +1,12 @@
+require 'spec_helper'
+
+describe Cubits::Invoice do
+  context 'class methods,' do
+    subject { described_class }
+
+    it { is_expected.to respond_to(:create) }
+    it { is_expected.to respond_to(:find) }
+  end # class methods
+
+  it { is_expected.to respond_to(:reload) }
+end # describe Cubits::Invoice

data/spec/lib/cubits/quote_spec.rb

@@ -0,0 +1,9 @@
+require 'spec_helper'
+
+describe Cubits::Quote do
+  context 'class methods,' do
+    subject { described_class }
+
+    it { is_expected.to respond_to(:create) }
+  end # class methods
+end # describe Cubits::Quote

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: cubits
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.1
 platform: ruby
 authors:
 - Alex Kukushkin
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-01-09 00:00:00.000000000 Z
+date: 2015-02-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: http
@@ -102,22 +102,29 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- CHANGES.md
 - Gemfile
 - LICENSE.txt
 - README.md
 - Rakefile
 - cubits.gemspec
 - lib/cubits.rb
+- lib/cubits/account.rb
 - lib/cubits/connection.rb
 - lib/cubits/errors.rb
 - lib/cubits/helpers.rb
 - lib/cubits/invoice.rb
+- lib/cubits/quote.rb
 - lib/cubits/resource.rb
 - lib/cubits/version.rb
+- spec/lib/cubits/account_spec.rb
 - spec/lib/cubits/connection_spec.rb
+- spec/lib/cubits/helpers_spec.rb
+- spec/lib/cubits/invoice_spec.rb
+- spec/lib/cubits/quote_spec.rb
 - spec/lib/cubits_spec.rb
 - spec/spec_helper.rb
-homepage: ''
+homepage: https://github.com/cubits/cubits-ruby
 licenses:
 - MIT
 metadata: {}
@@ -142,6 +149,10 @@ signing_key:
 specification_version: 4
 summary: Ruby client for Cubits Merchant API
 test_files:
+- spec/lib/cubits/account_spec.rb
 - spec/lib/cubits/connection_spec.rb
+- spec/lib/cubits/helpers_spec.rb
+- spec/lib/cubits/invoice_spec.rb
+- spec/lib/cubits/quote_spec.rb
 - spec/lib/cubits_spec.rb
 - spec/spec_helper.rb