bitex 0.3 → 0.4.0

data/lib/bitex/usd_withdrawal.rb

@@ -1,5 +1,6 @@
 module Bitex
   # A withdrawal of USD from your bitex.la balance
+  #
   class UsdWithdrawal
     # @!attribute id
     #   @return [Integer] This UsdWithdrawal's unique ID.
@@ -17,19 +18,16 @@ module Bitex
     #  Returns the status of this withdrawal.
     #  * :received Our engine is checking if you have enough funds.
     #  * :pending your withdrawal was accepted and is being processed.
-    #  * :done your withdrawal was processed and it's on its way through
-    #    the withdrawal channel you chose.
+    #  * :done your withdrawal was processed and it's on its way through the withdrawal channel you chose.
     #  * :cancelled your withdrawal could not be processed.
     attr_accessor :status
 
     # @!attribute reason
     #  Returns the reason for cancellation of this withdrawal, if any.
     #  * :not_cancelled
-    #  * :insufficient_funds The instruction was received, but you didn't have enough
-    #    funds available
+    #  * :insufficient_funds The instruction was received, but you didn't have enough funds available.
     #  * :no_instructions We could not understand the instructions you provided.
-    #  * :recipient_unknown we could not issue this withdrawal because you're
-    #    not the receiving party.
+    #  * :recipient_unknown we could not issue this withdrawal because you're not the receiving party.
     attr_accessor :reason
 
     # @!attribute countr
@@ -42,7 +40,7 @@ module Bitex
 
     # @!attribute payment_method
     #  Returns the payment method for this withdrawal.
-    #  * :international_bank International bank transfer
+    #  * :international_bank International bank transfer.
     #  * :bb we'll contact you regarding this withdrawal.
     attr_accessor :payment_method
 
@@ -56,42 +54,31 @@ module Bitex
     attr_accessor :instructions
 
     # @visibility private
+    # rubocop:disable Metrics/AbcSize
     def self.from_json(json)
-      status_lookup = {
-        1 => :received,
-        2 => :pending,
-        3 => :done,
-        4 => :cancelled,
-      }
-      reason_lookup = {
-        0 => :not_cancelled,
-        1 => :insufficient_funds,
-        2 => :no_instructions,
-        3 => :recipient_unknown,
-      }
       Api.from_json(new, json) do |thing|
-        thing.amount = BigDecimal.new(json[3].to_s)
-        thing.status = status_lookup[json[4]]
-        thing.reason = reason_lookup[json[5]]
+        thing.amount = (json[3].presence || 0).to_d
+        thing.status = statuses[json[4]]
+        thing.reason = reasons[json[5]]
         thing.country = json[6]
         thing.currency = json[7]
-        thing.payment_method = json[8]
+        thing.payment_method = payment_methods[json[8]]
         thing.label = json[9]
         thing.kyc_profile_id = json[10]
         thing.instructions = json[11]
       end
     end
+    # rubocop:enable Metrics/AbcSize
 
-    def self.create!(country, amount, currency, method, instructions, label, profile=nil)
-      from_json(Api.private(:post, "/private/usd/withdrawals", {
-        country: country,
-        amount: amount,
-        currency: currency,
-        payment_method: method,
-        instructions: instructions,
-        label: label,
-        kyc_profile_id: profile,
-      }))
+    def self.create!(country, amount, currency, method, instructions, label, profile = nil)
+      from_json(
+        Api.private(
+          :post,
+          '/private/usd/withdrawals',
+          country: country, amount: amount, currency: currency, payment_method: method, instructions: instructions, label: label,
+          kyc_profile_id: profile
+        )
+      )
     end
 
     def self.find(id)
@@ -99,7 +86,19 @@ module Bitex
     end
 
     def self.all
-      Api.private(:get, "/private/usd/withdrawals").collect{|x| from_json(x) }
+      Api.private(:get, '/private/usd/withdrawals').map { |sw| from_json(sw) }
+    end
+
+    def self.payment_methods
+      { 1 => :bb, 2 => :international_bank }
+    end
+
+    def self.reasons
+      { 0 => :not_cancelled, 1 => :insufficient_funds, 2 => :no_instructions, 3 => :recipient_unknown }
+    end
+
+    def self.statuses
+      { 1 => :received, 2 => :pending, 3 => :done, 4 => :cancelled }
     end
   end
 end

data/lib/bitex/version.rb

@@ -1,3 +1,3 @@
 module Bitex
-  VERSION = "0.3"
+  VERSION = '0.4.0'.freeze
 end

data/spec/ask_spec.rb

@@ -2,19 +2,31 @@ require 'spec_helper'
 
 describe Bitex::Ask do
   let(:as_json) do
-    [2,12345678,946685400,1,100.00000000,100.00000000,1000.00000000,1,0,10.0,'User#1']
+    [
+      1,         #  0 - API class reference
+      12345678,  #  1 - id
+      946685400, #  2 - created_at
+      1,         #  3 - orderbook
+      100.0,     #  4 - quantity
+      100.0,     #  5 - remaining_quantity
+      1000.0,    #  6 - price
+      1,         #  7 - status
+      0,         #  8 - reason
+      10.0,      #  9 - produced_amount
+      'User#1'   # 10 - issuer
+    ]
   end
-  
+
   it_behaves_like 'API class'
-  it_behaves_like 'API class with a specie'
+  it_behaves_like 'API class with a orderbook'
   it_behaves_like 'JSON deserializable order'
 
   describe 'Api calls' do
-    before(:each){ Bitex.api_key = 'valid_api_key' }
+    before(:each) { Bitex.api_key = 'valid_api_key' }
     it_behaves_like 'Order', 'asks'
   end
 
-  { quantity: 100.0, remaining_quantity: 100.0, produced_amount: 10.0}.each do |field, value|
+  { quantity: 100.0, remaining_quantity: 100.0, produced_amount: 10.0 }.each do |field, value|
     it "sets #{field} as BigDecimal" do
       thing = subject.class.from_json(as_json).send(field)
       thing.should be_a BigDecimal

data/spec/bid_spec.rb

@@ -2,19 +2,31 @@ require 'spec_helper'
 
 describe Bitex::Bid do
   let(:as_json) do
-    [1,12345678,946685400,1,100.00000000,100.00000000,1000.00000000,1,0,10.0,'User#1']
+    [
+      1,           #  0 - API class reference
+      12_345_678,  #  1 - id
+      946_685_400, #  2 - created_at
+      1,           #  3 - orderbook
+      100.0,       #  4 - quantity
+      100.0,       #  5 - remaining_quantity
+      1_000.0,     #  6 - price
+      1,           #  7 - status
+      0,           #  8 - reason
+      10.0,        #  9 - produced_amount
+      'User#1'     # 10 - issuer
+    ]
   end
-  
+
   it_behaves_like 'API class'
-  it_behaves_like 'API class with a specie'
+  it_behaves_like 'API class with a orderbook'
   it_behaves_like 'JSON deserializable order'
 
   describe 'Api calls' do
-    before(:each){ Bitex.api_key = 'valid_api_key' }
+    before(:each) { Bitex.api_key = 'valid_api_key' }
     it_behaves_like 'Order', 'bids'
   end
 
-  { amount: 100.0, remaining_amount: 100.0, produced_quantity: 10.0}.each do |field, value|
+  { amount: 100.0, remaining_amount: 100.0, produced_quantity: 10.0 }.each do |field, value|
     it "sets #{field} as BigDecimal" do
       thing = subject.class.from_json(as_json).send(field)
       thing.should be_a BigDecimal

data/spec/buy_spec.rb

@@ -2,14 +2,24 @@ require 'spec_helper'
 
 describe Bitex::Buy do
   let(:as_json) do
-    [4,12345678,946685400,1,100.50000000,201.0000000,0.05000000,2.00000000,456]
+    [
+      4,           #  0 - API class reference
+      12_345_678,  #  1 - id
+      946_685_400, #  2 - created_at
+      1,           #  3 - orderbook
+      100.5,       #  4 - quantity
+      201,         #  5 - amount
+      0.05,        #  6 - fee
+      2,           #  7 - price
+      456          #  8 - bid_id
+    ]
   end
-  
+
   it_behaves_like 'API class'
-  it_behaves_like 'API class with a specie'
+  it_behaves_like 'API class with a orderbook'
   it_behaves_like 'JSON deserializable match'
 
-  it "sets the bid id" do
+  it 'sets the bid id' do
     thing = subject.class.from_json(as_json).bid_id
     thing.should == 456
   end

data/spec/kyc_file_spec.rb

@@ -1,30 +1,46 @@
 require 'spec_helper'
 
 describe Bitex::KycFile do
-  before :each do 
-    Bitex.api_key = 'valid_api_key'
-  end
+  before(:each) { Bitex.api_key = 'valid_api_key' }
 
-  let(:as_json) do
-    [1,2,'http://foo.bar.example/photo.jpg', 'photo.jpg', 'application/jpeg', 10000]
-  end
+  let(:id) { 1 }
+  let(:kyc_profile_id) { 2 }
+  let(:url) { 'http://foo.bar.example/photo.jpg' }
+  let(:file_name) { 'photo.jpg' }
+  let(:file_size) { 10_000 }
+  let(:content_type) { 'application/jpeg' }
+
+  let(:as_json) { [id, kyc_profile_id, url, file_name, content_type, file_size] }
+  let(:kyc_file) { subject.class.from_json(as_json)  }
+  let(:kyc_files) { Bitex::KycFile.all }
+
+  context 'deserializing from json' do
+    it 'sets url as String' do
+      kyc_file.url.should be_an String
+      kyc_file.url.should eq url
+    end
 
-  { id: 1,
-    kyc_profile_id: 2,
-    url:'http://foo.bar.example/photo.jpg',
-    file_name: 'photo.jpg',
-    content_type: 'application/jpeg',
-    file_size: 10000
-  }.each do |field, value|
-    it "sets #{field}" do
-      subject.class.from_json(as_json).send(field).should == value
+    it 'sets file name as String' do
+      kyc_file.file_name.should be_an String
+      kyc_file.file_name.should eq file_name
+    end
+
+    it 'sets file size as Integer' do
+      kyc_file.file_size.should be_an Integer
+      kyc_file.file_size.should eq file_size
+    end
+
+    it 'sets content type as String' do
+      kyc_file.content_type.should be_an String
+      kyc_file.content_type.should eq content_type
     end
   end
 
   it 'lists all kyc profiles' do
-    stub_private(:get, '/private/kyc_files', 'kyc_files')
-    kyc_files = Bitex::KycFile.all
+    stub_private(:get, '/private/kyc_files', :kyc_files)
+
     kyc_files.should be_an Array
-    kyc_files.first.should be_an Bitex::KycFile
+    kyc_files.sample.should be_an Bitex::KycFile
+    kyc_files.find(id: id).should be_present
   end
 end

data/spec/kyc_profile_spec.rb

@@ -1,154 +1,190 @@
 require 'spec_helper'
 
 describe Bitex::KycProfile do
-  before :each do 
-    Bitex.api_key = 'valid_api_key'
-  end
+  before(:each) { Bitex.api_key = 'valid_api_key' }
 
-  let(:params_for_create_or_update) do
-    { first_name: 'Billy',
-      last_name: 'Bob',
-      personal_id_number: '33222111N',
-      personal_id_issuer: 'AR',
-      personal_id_type: 'passport',
-      tax_id: '4332221115',
-      birth_date: Time.at(946685400),
-      nationality: 'brazilian',
-      gender: 'male',
-      occupation: 'Singer',
-      home_address: 'Argentina, Buenos Aires, etc',
-      work_address: 'Argentina, La Plata',
-      phone_numbers: '+51 555 120921',
-      legal_entity: true,
-      politically_exposed_person: true,
-      usage_tier: 'micro'
-    }
-  end
-  
-  let(:rest_params_for_create_or_update) do
-    { first_name: 'Billy',
-      last_name: 'Bob',
-      personal_id_number: '33222111N',
-      personal_id_issuer: 'AR',
-      personal_id_type: 'passport',
-      tax_id: '4332221115',
-      birth_date: '1999/12/31',
-      nationality: 'brazilian',
-      gender: 'male',
-      occupation: 'Singer',
-      home_address: 'Argentina, Buenos Aires, etc',
-      work_address: 'Argentina, La Plata',
-      phone_numbers: '+51 555 120921',
-      legal_entity: true,
-      politically_exposed_person: true,
-      usage_tier: 'micro',
+  let(:id) { 1 }
+  let(:first_name) { 'Billy' }
+  let(:last_name) { 'Bob' }
+  let(:personal_id_number) { '33222111N' }
+  let(:personal_id_issuer) { 'AR' }
+  let(:personal_id_type) { :passport }
+  let(:tax_id) { 4_332_221_115 }
+  let(:birth_date) { Time.at(946_685_400).utc }
+  let(:rest_birth_date) { '2000/01/01' }
+  let(:nationality) { 'brazilian' }
+  let(:gender) { :male }
+  let(:occupation) { 'Singer' }
+  let(:home_address) { 'Argentina, Buenos Aires, etc' }
+  let(:work_address) { 'Argentina, La Plata' }
+  let(:phone_numbers) { '+51 555 120921' }
+  let(:legal_entity) { true }
+  let(:politically_exposed_person) { true }
+  let(:usage_tier) { :micro }
+  let(:accepted_usage_tier) { :micro }
+
+  let(:kyc_profile_params) do
+    {
+      first_name: first_name, last_name: last_name, personal_id_number: personal_id_number,
+      personal_id_issuer: personal_id_issuer, personal_id_type: personal_id_type, tax_id: tax_id, birth_date: birth_date,
+      nationality: nationality, gender: gender, occupation: occupation, home_address: home_address, work_address: work_address,
+      phone_numbers: phone_numbers, legal_entity: legal_entity, politically_exposed_person: politically_exposed_person,
+      usage_tier: usage_tier
     }
   end
 
   let(:as_json) do
-    [           1,   # Kyc Profile id.
-                 'Billy',   # Name
-                   'Bob',   # Last Name.
-             '33222111N',   # Personal ID Number
-                    'AR',   # ISO country code for the issuer of this ID.
-              'passport',   # Type of ID
-            '4332221115',   # Tax Id
-               946685400,   # Birth date as unix timestamp.
-             'brazilian',   # Nationality
-                  'male',   # Gender
-                'Singer',   # Occupation
-     'Argentina, Buenos Aires, etc',   # Home address.
-     'Argentina, La Plata',   # Work address.
-        '+51 555 120921',   # Phone numbers.
-                    true,   # Is legal entity.
-                    true,   # Is politically exposed.
-                 'micro',   # Requested usage tier.
-                 'micro',   # Current usage tier as accepted by
-                            # our compliance officers.
-    ]
+    [id, first_name, last_name, personal_id_number, personal_id_issuer, personal_id_type, tax_id, birth_date, nationality,
+     gender, occupation, home_address, work_address, phone_numbers, legal_entity, politically_exposed_person, usage_tier,
+     accepted_usage_tier]
   end
 
-  { id: 1,
-    first_name: 'Billy',
-    last_name: 'Bob',
-    personal_id_number: '33222111N',
-    personal_id_issuer: 'AR',
-    personal_id_type: 'passport',
-    tax_id: '4332221115',
-    birth_date: Time.at(946685400),
-    nationality: 'brazilian',
-    gender: 'male',
-    occupation: 'Singer',
-    home_address: 'Argentina, Buenos Aires, etc',
-    work_address: 'Argentina, La Plata',
-    phone_numbers: '+51 555 120921',
-    legal_entity: true,
-    politically_exposed_person: true,
-    usage_tier: 'micro',
-    accepted_usage_tier: 'micro',
-  }.each do |field, value|
-    it "sets #{field}" do
-      subject.class.from_json(as_json).send(field).should == value
+  let(:kyc_profile) { subject.class.from_json(as_json) }
+
+  context 'deserializing from json' do
+    it 'sets first name as String' do
+      kyc_profile.first_name.should be_an String
+      kyc_profile.first_name.should eq first_name
+    end
+
+    it 'sets last name as String' do
+      kyc_profile.last_name.should be_an String
+      kyc_profile.last_name.should eq last_name
+    end
+
+    it 'sets personal ID number as String' do
+      kyc_profile.personal_id_number.should be_an String
+      kyc_profile.personal_id_number.should eq personal_id_number
+    end
+
+    it 'sets personal ID issuer as String' do
+      kyc_profile.personal_id_issuer.should be_an String
+      kyc_profile.personal_id_issuer.should eq personal_id_issuer
+    end
+
+    it 'sets personal ID type as Symbol' do
+      kyc_profile.personal_id_type.should be_an Symbol
+      kyc_profile.personal_id_type.should eq personal_id_type
+    end
+
+    it 'sets tax ID as Integer' do
+      kyc_profile.tax_id.should be_an Integer
+      kyc_profile.tax_id.should eq tax_id
+    end
+
+    it 'sets birth date as Time' do
+      kyc_profile.birth_date.should be_an Time
+      kyc_profile.birth_date.should eq birth_date
+    end
+
+    it 'can have a nil birth_date' do
+      as_json[7] = nil
+
+      kyc_profile.birth_date.should be_nil
+    end
+
+    it 'sets nationality as String' do
+      kyc_profile.nationality.should be_an String
+      kyc_profile.nationality.should eq nationality
+    end
+
+    it 'sets gender as Symbol' do
+      kyc_profile.gender.should be_an Symbol
+      kyc_profile.gender.should be gender
+    end
+
+    it 'sets occupation as String' do
+      kyc_profile.occupation.should be_an String
+      kyc_profile.occupation.should eq occupation
+    end
+
+    it 'sets home address as String' do
+      kyc_profile.home_address.should be_an String
+      kyc_profile.home_address.should eq home_address
+    end
+
+    it 'sets work address as String' do
+      kyc_profile.work_address.should be_an String
+      kyc_profile.work_address.should eq work_address
+    end
+
+    it 'sets phone numbers as String' do
+      kyc_profile.phone_numbers.should be_an String
+      kyc_profile.phone_numbers.should eq phone_numbers
+    end
+
+    it 'sets legal entity as Boolean' do
+      kyc_profile.legal_entity.should be_an TrueClass
+      kyc_profile.legal_entity.should eq legal_entity
+    end
+
+    it 'sets politically exposed person as Boolean' do
+      kyc_profile.politically_exposed_person.should be_an TrueClass
+      kyc_profile.politically_exposed_person.should eq politically_exposed_person
+    end
+
+    it 'sets usage tier as Symbol' do
+      kyc_profile.usage_tier.should be_an Symbol
+      kyc_profile.usage_tier.should eq usage_tier
+    end
+
+    it 'sets accepted usage tier as Symbol' do
+      kyc_profile.accepted_usage_tier.should be_an Symbol
+      kyc_profile.accepted_usage_tier.should eq accepted_usage_tier
     end
   end
 
   it 'creates a new kyc profile' do
-    stub_private(:post, "/private/kyc_profiles", 'kyc_profile',
-      rest_params_for_create_or_update)
-    Bitex::KycProfile.create!(params_for_create_or_update)
-      .should be_a Bitex::KycProfile
+    stub_private(:post, '/private/kyc_profiles', :kyc_profile, kyc_profile_params.merge(birth_date: rest_birth_date))
+
+    Bitex::KycProfile.create!(kyc_profile_params).should be_a Bitex::KycProfile
   end
-  
+
   it 'finds a single kyc profile' do
-    stub_private(:get, '/private/kyc_profiles/1', 'kyc_profile')
-    kyc_profile = Bitex::KycProfile.find(1)
+    stub_private(:get, "/private/kyc_profiles/#{id}", :kyc_profile)
+
+    kyc_profile = Bitex::KycProfile.find(id)
+
     kyc_profile.should be_a Bitex::KycProfile
+    kyc_profile.id.should eq id
+  end
+
+  it 'updates a kyc profile' do
+    stub_private(:put, "/private/kyc_profiles/#{id}", :kyc_profile, kyc_profile_params.merge(birth_date: rest_birth_date))
+
+    kyc_profile.update!(kyc_profile_params)
+    kyc_profile.birth_date.should eq birth_date
   end
-  
+
   it 'lists all kyc profiles' do
-    stub_private(:get, '/private/kyc_profiles', 'kyc_profiles')
+    stub_private(:get, '/private/kyc_profiles', :kyc_profiles)
+
     kyc_profiles = Bitex::KycProfile.all
+
     kyc_profiles.should be_an Array
     kyc_profiles.first.should be_an Bitex::KycProfile
   end
 
-  it 'updates a kyc profile' do
-    stub_private(:put, "/private/kyc_profiles/1", 'kyc_profile',
-      rest_params_for_create_or_update)
-    kyc_profile = Bitex::KycProfile.from_json(as_json)
-    kyc_profile.update!(params_for_create_or_update)
-  end
-
   it 'creates a kyc file' do
-    path =  File.expand_path('../fixtures/file.jpg', __FILE__)
-    stub_private(:post, '/private/kyc_profiles/1/kyc_files', 'kyc_file',
-     {document: path, document_content_type: 'image/jpg'})
-    kyc_profile = Bitex::KycProfile.from_json(as_json)
-    kyc_file = kyc_profile.add_kyc_file!(path, 'image/jpg')
-    kyc_file.should be_a Bitex::KycFile
+    path = File.expand_path('fixtures/file.jpg', __dir__)
+    stub_private(:post, "/private/kyc_profiles/#{id}/kyc_files", :kyc_file, document: path, document_content_type: 'image/jpg')
+
+    kyc_profile.add_kyc_file!(path, 'image/jpg') { |kyc_file| kyc_file.should be_a Bitex::KycFile }
   end
 
   it 'creates a kyc file without specifying content type' do
-    path =  File.expand_path('../fixtures/file.jpg', __FILE__)
-    stub_private(:post, '/private/kyc_profiles/1/kyc_files', 'kyc_file',
-     {document: path})
-    kyc_profile = Bitex::KycProfile.from_json(as_json)
-    kyc_file = kyc_profile.add_kyc_file!(path)
-    kyc_file.should be_a Bitex::KycFile
+    path = File.expand_path('fixtures/file.jpg', __dir__)
+    stub_private(:post, '/private/kyc_profiles/1/kyc_files', :kyc_file, document: path)
+
+    kyc_profile.add_kyc_file!(path) { |kyc_file| kyc_file.should be_a Bitex::KycFile }
   end
-  
+
   it 'lists a profiles kyc files' do
-    stub_private(:get, '/private/kyc_profiles/1/kyc_files', 'kyc_files')
-    kyc_profile = Bitex::KycProfile.from_json(as_json)
-    kyc_files = kyc_profile.kyc_files
-    kyc_files.should be_an Array
-    kyc_files.first.should be_a Bitex::KycFile
-  end
-  
-  it 'can have a nil birth_date' do
-    json = as_json.dup
-    json[7] = nil
-    kyc_profile = Bitex::KycProfile.from_json(json)
-    kyc_profile.birth_date.should be_nil
+    stub_private(:get, "/private/kyc_profiles/#{id}/kyc_files", :kyc_files)
+
+    kyc_profile.kyc_files do |kyc_files|
+      kyc_files.should be_an Array
+      kyc_files.sample.should be_a Bitex::KycFile
+    end
   end
 end