rents 0.1.8 → 0.1.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a327799ef5d6a8f839d585f439c66175840b43d3
-  data.tar.gz: 408e23d19204f9c0a02e20862a18e7da15e6e18f
+  metadata.gz: 78f0ca2bdd14b5b3ec218b9c3058c738ba6d7874
+  data.tar.gz: 7ac12d3c2e9e29ea4c0c666481c54972bb7c51bd
 SHA512:
-  metadata.gz: adb938ec71faaba5ee72d02719cdffd1c863837a8d6ecf61f0c540927fdf70264d37a5d3406462e038bdcd0470c08915758d58e43bdff9f0211b061445cf0b8b
-  data.tar.gz: 0676b519e80b18242f032736175c13af95f2d76df8040d781d50933aa977ca236138df30ce93ca3dd2d923869725eab2008cba9d3d2c44cf4e22f8bfdab1f5cf
+  metadata.gz: 3ea1faa458f68b72f6f6021337979d5d6f5a015329c7a87413c19179af4497ea1c7affa827224dcaccac9fcc18ffd55729df26599b5e232af4c1cc4dbf0801fb
+  data.tar.gz: 56293d94bfef00a16ad362be770130aaac44b34416884591be0b756483bd3aa9e7a4b7414aff308356cf6637b8455262932975debe468ffe0ec3e2850371832a

data/lib/generators/rents/install_generator.rb

@@ -0,0 +1,15 @@
+module Rents
+  module Generators
+    class InstallGenerator < Rails::Generators::Base
+      source_root File.expand_path("../../templates", __FILE__)
+      
+      desc "It automatically create it initializer RentS rails app config"
+      
+      def copy_initializer
+        template "rents.rb", "config/initializers/rents.rb"
+        puts 'Check your config/initializers/rents.rb & read it comments'.colorize(:light_yellow)
+      end
+      
+    end
+  end
+end

data/lib/generators/templates/rents.rb

@@ -0,0 +1,35 @@
+# encoding: utf-8
+
+# TODO if using Rails 4 or greater use copy and paste on your secret.yml:
+# rents:
+#   app_id: # TODO your app_id
+#   app_secret_key: # TODO your app_secret_key
+# IMPORTANT: remember that test & development is not necessary if using test_env, but if you want your test app remember to use you test_app id & secret
+
+# It automatic the RentS to it TestEnv & ProductionEnv
+if Rails.env.development? || Rails.env.test?
+  # TODO if using Rails 3 or older & not using the TEST_ENV, put here your TEST app_id & your secret_key
+  Rents.app_id = ''
+  Rents.secret_key = ''
+
+  # TODO: Uncomment test_env if you want to test using RentS default & global app
+  # Rents.test_env = true
+  # TODO: Uncomment debugger if you have an RentS instance on your machine
+  # Rents.debugger = true
+elsif Rails.env.production?
+  # TODO if using Rails 3 or older, put here your PRODUCTION app_id & your secret_key
+  Rents.app_id = ''
+  Rents.secret_key = ''
+
+  # For production remember to keep it false or just remove it
+  Rents.test_env = false
+  Rents.debugger = false
+end
+
+# Get your App config if your not using TEST_ENV nor DEBUGGER
+if (Rents.test_env.nil? && Rents.debugger.nil?) || (Rents.test_env == false && Rents.debugger == false)
+  if Rails.version[0].to_i >= 4
+    Rents.app_id = Rails.application.secrets.rents.app_id
+    Rents.secret_key = Rails.application.secrets.rents.app_secret_key
+  end
+end

data/lib/rents/connection.rb

@@ -11,18 +11,22 @@ module Rents
 
     # Constructor
     def initialize(params = {})
+      # An work around added to prevent a lot of changes
+      params = params.merge({test_env:true}) if Rents.test_env
+      params = params.merge({debugger:true}) if Rents.debugger
+
       # Static part
       self.request_params = {transaction:params}
       setup_attrs(params)
       setup_config
-      #TODO self.domain = 'localhost:7000' #'rents.pagerenter.com.br'
-      self.domain = 'apprents.herokuapp.com'
+      self.domain = 'apprents.herokuapp.com' # 'rents.pagerenter.com.br'
+      self.domain = 'localhost:7000' if params[:debugger]
       self.api_version = 'v1'
       self.end_point = "http://#{self.domain}/api"
       self.end_point_versioned = "http://#{self.domain}/api/#{self.api_version}"
 
       # Dynamic env
-      setup_default_app unless params[:test_env].nil?
+      setup_default_app if params[:test_env]
     end
 
     # Full URL for the last request
@@ -66,6 +70,8 @@ module Rents
         app = get_json_request[:app]
         Rents.app_id = app[:id]
         Rents.secret_key = app[:secret]
+
+        return puts 'Please run: rails g rents:install' if Rents.app_id.nil? || Rents.secret_key.nil?
         self.auth = {app_id:Rents.app_id, secret_key:Rents.secret_key}
         self.request_params.merge!(auth:self.auth)
       end

data/lib/rents/currency.rb

@@ -0,0 +1,65 @@
+module Rents
+  # Currency Obj, useful methods to work with many different countries
+  class Currency
+    # Receive it amount in Decimal and convert to operator str, like 10,00 or 10.00 to 1000
+    def self.to_operator_str amount
+      # Check invalid entry
+      return nil if amount.nil?
+      amount = amount.to_s if amount.is_a?Integer
+
+      # Convert from BigDecimal
+      if amount.is_a?BigDecimal
+        aux_amount_str = amount.to_s('F')
+        cents = aux_amount_str[aux_amount_str.index('.'), aux_amount_str.length]
+
+        # Check if there is a bug because the Decimal didn't recognize the second 0
+        aux_amount_str = "#{aux_amount_str}0"if cents.index('.')
+
+        return aux_amount_str.remove('.')
+      end
+
+      # Create the amount as String
+      amount.is_a?(String) ? amount_str = amount : amount_str = amount.to_s
+      amount_str_not_formatted = amount_str.remove('.').remove(',')
+
+      # Create the full value
+      cents_value = amount_str_not_formatted[amount_str_not_formatted.length-2, amount_str_not_formatted.length-1]
+      integer_value = amount_str_not_formatted[0, amount_str_not_formatted.length-2]
+
+      # The return constraint
+      "#{integer_value}#{cents_value}"
+    end
+
+    # Receive it amount in Integer String (like 1000 that means 10,00 or 10.00) and convert to Decimal value
+    def self.to_decimal amount
+      # If it was passed a BigDecimal it must be passed to operator format
+      amount = Currency.to_operator_str(amount) if amount.is_a?BigDecimal
+
+      # Base vars
+      aux_amount = amount
+      cents_chars_counter = 2
+
+      # Building the currency str like BigDecimal understands
+      cents_str = aux_amount[aux_amount.length-cents_chars_counter..aux_amount.length]
+      integer_str = aux_amount[0, aux_amount.length-cents_chars_counter]
+      new_amount = "#{integer_str}.#{cents_str}"
+
+      BigDecimal.new new_amount
+    end
+
+    # Get it cents from operator amount formatted
+    def self.get_cents amount
+      aux = amount.to_s
+      cents_length = 2
+      aux[aux.length-cents_length, aux.length]
+    end
+
+    # Receive a numeric form operator format & retrieve it
+    def self.have_cents? amount
+      aux = "#{amount.to_f/100}" if amount.is_a?(String) || amount.is_a?(Integer)
+      aux = amount.to_s if amount.is_a?Float
+      cents = aux[aux.index('.')+1, aux.length]
+      cents.length == 2 ? true : false
+    end
+  end
+end

data/lib/rents/string.rb

@@ -0,0 +1,13 @@
+class String
+  def remove(pattern)
+    gsub pattern, ''
+  end
+
+  def integer?
+    self.to_i.to_s == self
+  end
+
+  def equals? str
+    self == str
+  end
+end

data/lib/rents/transaction.rb

@@ -17,6 +17,11 @@ module Rents
       self.resp[:rid]
     end
 
+    # Return it Purchase URL, to pay on the OperatorPage
+    def purchase_url
+      self.resp[:purchase_url]
+    end
+
     # GET /api/transactions/:rid by it attr
     def verify
       auth_hash = {}
@@ -29,7 +34,7 @@ module Rents
     def charge_page full_resp=false
       custom_http_params
       # SetUp redirect dynamic if is test
-      self.request_params[:transaction][:redirect_link] = "#{self.redirect_link}/test" if self.request_params[:transaction][:test_env]
+      self.request_params[:transaction][:redirect_link] = "#{self.redirect_link}" if self.request_params[:transaction][:test_env]
 
       # dynamic path (it is written when a specific method use it)
       self.path = "transactions/page"

data/lib/rents/version.rb

@@ -1,6 +1,6 @@
 module Rents
   MAJOR = 0
   MINOR = 1
-  PATCH = 8
+  PATCH = 9
   VERSION = "#{MAJOR}.#{MINOR}.#{PATCH}"
 end

data/lib/rents.rb

@@ -2,17 +2,24 @@
 require 'json'
 require 'curl'
 require 'rest_client'
+require 'bigdecimal'
+require 'bigdecimal/util'
 
 # Overrides
 require 'rents/hash'
 
 # Gem files
-[:version, :connection, :status, :transaction].each { |lib| require "rents/#{lib}" }
+[:version, :connection, :status, :transaction, :currency, :string].each { |lib| require "rents/#{lib}" }
 
 module Rents
+  # Production settings
   @@app_id = nil
   @@secret_key = nil
 
+  # Tests settings
+  @@test_env = nil
+  @@debugger = nil
+
   def self.app_id=(app_id)
     @@app_id = app_id
   end
@@ -28,4 +35,20 @@ module Rents
   def self.secret_key
     @@secret_key
   end
+
+  def self.test_env
+    @@test_env
+  end
+
+  def self.test_env=(test_env)
+    @@test_env = test_env
+  end
+
+  def self.debugger
+    @@test_env
+  end
+
+  def self.debugger=(debugger)
+    @@debugger = debugger
+  end
 end

data/rents.gemspec

@@ -18,6 +18,8 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ["lib"]
 
+  #================== GEMs to build it GEM, so its improve the development ==============================
+  # Base GEMs to build it gem
   spec.add_development_dependency "bundler", "~> 1.6"
   spec.add_development_dependency "rake", "~> 10.3", '>= 10.3.2'
 
@@ -27,10 +29,16 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'simplecov', '~> 0.7', '>= 0.7.1'
   # Create readable attrs values
   spec.add_development_dependency 'faker', '~> 1.4', '>= 1.4.2'
+
+  #================== GEMs to be used when it is called on a project ====================================
   # For real user operator IP (4GeoLoc)
   spec.add_dependency 'curb', "~> 0.8", '>= 0.8.6'
   # HTTP REST Client
   spec.add_dependency "rest-client", '~> 1.7', '>= 1.7.2'
   # Easy JSON create
   spec.add_dependency "multi_json", '~> 1.10', '>= 1.10.1'
+  # To pretty print on console
+  spec.add_dependency "colorize", '~> 0.7.3', '>= 0.7.3'
+  # To work with the Rails Numeric for currency
+  spec.add_dependency 'bigdecimal', '~> 1.2.5', '>= 1.2.5'
 end

data/spec/rents/conversions_spec.rb

@@ -0,0 +1,36 @@
+=begin
+  require 'spec_helper'
+
+  describe 'Numeric conversions' do
+    describe 'BigDecimalBackup conversions' do
+      # setup it vars to have the conversion tested, value: 1999 (nineteen ninety nine)
+      pt_br = '1.999,00'
+      en_us = '1,999.00'
+
+      # Value like the card operator uses
+      operator_expected_value = '199900'
+      operator_value = '199900'
+      decimal_expected_value = BigDecimal.new '1999.00'
+
+      # it is the Rails conversion form the Form for Decimal input
+      decimal_obj_pt_br = BigDecimal.new(pt_br)
+      decimal_obj_en_us = BigDecimal.new(en_us.remove('.').remove(','))
+
+      # Conversions
+      pt_br_converted = Currency.to_operator_str decimal_obj_pt_br
+      en_us_converted = Currency.to_operator_str decimal_obj_en_us
+      decimal_converted = Currency.to_decimal operator_value
+
+      context 'Operator Format value' do
+
+      end
+
+      it 'should be running correctly' do
+        status = Rents::Status.new
+        expect(status.http_code).to equal(200)
+        expect(status.api_code).to equal(200)
+        expect(status.message).not_to be nil
+      end
+    end
+  end
+=end

data/spec/rents/currency_spec.rb

@@ -0,0 +1,108 @@
+require 'spec_helper'
+
+describe Rents::Currency do
+  describe "Operator Format value" do
+    # setup it vars to have the conversion tested, value: 1999 (nineteen ninety nine)
+    pt_br = '1.999,00'
+    en_us = '1,999.00'
+
+    # Values expected
+    operator_value = '199900'
+    operator_expected_value = '199900'
+    integer_value = '199900'.to_i
+    decimal_value = BigDecimal.new '1999.00'
+    decimal_expected_value = BigDecimal.new '1999.00'
+    operator_with_cents = '300055' # R$ 3.000,55
+    non_cents_expected = '00'
+    cents_expected = '55'
+
+    # Values Converted to operator format
+    pt_br_operator_converted = Rents::Currency.to_operator_str pt_br
+    en_us_operator_converted = Rents::Currency.to_operator_str en_us
+    decimal_converted = Rents::Currency.to_decimal operator_value
+    big_decimal_converted = Rents::Currency.to_operator_str decimal_value
+    integer_converted = Rents::Currency.to_operator_str integer_value
+    cents_received = Rents::Currency.get_cents operator_with_cents
+    non_cents_received = Rents::Currency.get_cents operator_value
+    float_with_cents = 1000.55
+    float_without_cents = 1000.0
+
+    context 'Decimal to Operator' do
+      # Convert PT_BR
+      it 'PT_BR should be convertible' do
+        expect(pt_br_operator_converted).to be_a String
+        expect(pt_br_operator_converted.index('.')).to be_nil
+        expect(pt_br_operator_converted.index(',')).to be_nil
+        expect(pt_br_operator_converted).to be_integer
+        expect(pt_br_operator_converted).to be_equals operator_expected_value
+      end
+
+      # Convert EN_US
+      it 'EN_US should be convertible' do
+        expect(en_us_operator_converted).to be_a String
+        expect(en_us_operator_converted.index('.')).to be_nil
+        expect(en_us_operator_converted.index(',')).to be_nil
+        expect(en_us_operator_converted).to be_integer
+        expect(en_us_operator_converted).to be_equals operator_expected_value
+      end
+
+      # To operator passing a BigDecimal instance
+      it 'should have a Operator format based on BigDecimal instance' do
+        expect(big_decimal_converted).to be_a String
+        expect(big_decimal_converted.index('.')).to be_nil
+        expect(big_decimal_converted.index(',')).to be_nil
+        expect(big_decimal_converted).to be_integer
+        expect(big_decimal_converted).to be_equals operator_expected_value
+      end
+    end
+
+    context 'Integer to Operator' do
+      it 'should have a Operator format based on Integer instance' do
+        expect(integer_converted).to be_a String
+        expect(integer_converted.index('.')).to be_nil
+        expect(integer_converted.index(',')).to be_nil
+        expect(integer_converted).to be_integer
+        expect(integer_converted).to be_equals operator_expected_value
+      end
+    end
+
+    context 'Operator to Decimal' do
+      # Convert from the operator to BigDecimal instance, like rails does/need
+      it 'should be the BigDecimal expected' do
+        expect(decimal_converted).to be_a BigDecimal
+        expect(decimal_converted).to be == decimal_expected_value
+      end
+
+      # Convert operator with cents to float correctly
+      it 'should convert with cents correctly' do
+
+      end
+    end
+
+    context 'Methods to work in operator format' do
+      it 'should retrieve existent cents' do
+        expect(cents_received).to be_equals cents_expected
+      end
+
+      it 'should retrieve the non existent cents' do
+        expect(non_cents_received).to be_equals non_cents_expected
+      end
+
+      it 'should have cents' do
+        expect(Rents::Currency.have_cents?(operator_with_cents)).to be_truthy
+      end
+
+      it 'should not have cents' do
+        expect(Rents::Currency.have_cents?(operator_value)).to_not be_truthy
+      end
+
+      it '(RECEIVING FLOAT) should have cents' do
+        expect(Rents::Currency.have_cents?(float_with_cents)).to be_truthy
+      end
+
+      it '(RECEIVING FLOAT) should not have cents' do
+        expect(Rents::Currency.have_cents?(float_without_cents)).to_not be_truthy
+      end
+    end
+  end
+end

data/spec/rents/transaction_spec.rb

@@ -5,14 +5,12 @@ describe Rents::Transaction do
   describe '(SUCCESS REQUEST) Operator - BuyPage' do
     # ================    SetUp/Config    ================
     before(:all) do
+      Rents.test_env=true
+      Rents.debugger=true
       base_url = 'http://localhost:7000'
 
-      @api_status = Rents::Status.new({
-        test_env:true
-      })
-
+      @api_status = Rents::Status.new
       @page_transaction = Rents::Transaction.new({
-        test_env:true,
         card:{flag:'visa'},
         amount: Random.rand(99999), # TODO: no error por rand menor que 99 (* mandatory) Amount in cents (1000 = R$ 10,00)
         redirect_link: "#{base_url}/api/redirect_receiver" # (* optional) used only for CieloPage
@@ -27,21 +25,28 @@ describe Rents::Transaction do
 
     # ================    Tests/Expects/Should   ================
     it 'resp should not be null' do
-      @page_resp.should_not be_nil
+      expect(@page_resp).to_not be_nil
+    end
+
+    it 'should setup the rid accessible method' do
+      expect(@page_transaction.rid).to_not be_nil
+    end
+
+    it 'should setup the purchase_url accessible method' do
+      expect(@page_transaction.purchase_url).to_not be_nil
     end
 
     it 'resp should not have any error' do
       error = @page_resp[:error]
       error = @page_resp['error'] if error.nil?
-      error.should be_nil
+      expect(error).to be_nil
     end
 
     it 'resp should be an accessible Operator URL' do
-      url = @page_resp['purchase_url']
-      url = @page_resp[:purchase_url] if url.nil?
+      url = @page_transaction.purchase_url
 
-      url.should_not be_nil
-      be_accessible(url).should be_true
+      expect(url).to_not be_nil
+      expect(accessible?(url)).to be_truthy
     end
 
     it 'must be verifiable' do
@@ -51,12 +56,13 @@ describe Rents::Transaction do
       error = verify_resp['error'] if error.nil?
 
       # Validations
-      verify_resp.should_not be_nil
-      error.should be_nil
+      expect(verify_resp).to_not be_nil
+      expect(error).to be_nil
     end
 
     it 'must have a get accessible URL request' do
-      be_accessible(@page_transaction.url_requested+@page_transaction.request_params.it_keys_to_get_param).should be_true
+      url = @page_transaction.url_requested+@page_transaction.request_params.it_keys_to_get_param
+      expect(be_accessible(url)).to be_truthy
     end
   end
 
@@ -64,6 +70,8 @@ describe Rents::Transaction do
   describe '(BAD REQUEST) Operator - BuyPage' do
     # SetUp/Config
     before(:each) do
+      Rents.test_env = false
+      Rents.debugger = false
       Rents.app_id = 1
       Rents.secret_key = '12312321312$2a$10$NmV9EysKVLe8ItBdl9CHN.LF05bOuDdoOkmfptdbJs7cuaDWksuUu'
       base_url = 'http://localhost:7000'
@@ -86,9 +94,9 @@ describe Rents::Transaction do
       error = json_resp['error'] if error.nil?
 
       # Check what expected
-      json_resp.should be_a Hash
-      @page_resp.code.should == 200
-      error.should_not be_nil
+      expect(json_resp).to be_a Hash
+      expect(@page_resp.code).to eq(200)
+      expect(error).to_not be_nil
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rents
 version: !ruby/object:Gem::Version
-  version: 0.1.8
+  version: 0.1.9
 platform: ruby
 authors:
 - Ilton Garcia
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-11-03 00:00:00.000000000 Z
+date: 2014-12-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -164,6 +164,46 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 1.10.1
+- !ruby/object:Gem::Dependency
+  name: colorize
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.7.3
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.7.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.7.3
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.7.3
+- !ruby/object:Gem::Dependency
+  name: bigdecimal
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.2.5
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.2.5
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.2.5
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.2.5
 description: Ruby gem for Rent$ payment Gateway & Intermediary
 email:
 - ilton_unb@hotmail.com
@@ -176,19 +216,26 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
+- lib/generators/rents/install_generator.rb
+- lib/generators/templates/rents.rb
 - lib/rents.rb
 - lib/rents/connection.rb
+- lib/rents/currency.rb
 - lib/rents/hash.rb
 - lib/rents/status.rb
+- lib/rents/string.rb
 - lib/rents/transaction.rb
 - lib/rents/version.rb
 - modelagem/Sequence - APIClient.asta
 - modelagem/Structure - ClassDiagram.asta
+- modelagem/WorkFlow - LocalGEM.asta
+- modelagem/WorkFlow - LocalGEM.png
 - modelagem/useful_files/card_operators/cielo/test_cards.txt
 - modelagem/useful_files/card_operators/cielo/test_keys.txt
 - rents.gemspec
 - spec/helpers.rb
-- spec/rents/rents_spec.rb
+- spec/rents/conversions_spec.rb
+- spec/rents/currency_spec.rb
 - spec/rents/status_spec.rb
 - spec/rents/transaction_spec.rb
 - spec/spec_helper.rb
@@ -218,7 +265,8 @@ specification_version: 4
 summary: Rent$ payment Gateway & Intermediary ruby gem
 test_files:
 - spec/helpers.rb
-- spec/rents/rents_spec.rb
+- spec/rents/conversions_spec.rb
+- spec/rents/currency_spec.rb
 - spec/rents/status_spec.rb
 - spec/rents/transaction_spec.rb
 - spec/spec_helper.rb

data/spec/rents/rents_spec.rb

@@ -1,12 +0,0 @@
-require 'spec_helper'
-
-describe Rents do
-  describe 'Base module' do
-=begin TODO test here like a Developer should use it GEM
-    it 'should be tested' do
-      Rents.app_id=44
-      expect(Rents.app_id).to equal(44)
-    end
-=end
-  end
-end