rents 0.0.0 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0ca18ee62fe39343f1c1a4ff80259d7909dd2659
-  data.tar.gz: bc2b145901b129167e17048ca246bad5fd9a310a
+  metadata.gz: 3870b6ddef5435fb81b227dbf0451e717aa20db6
+  data.tar.gz: fa42db010bcd1d33566b63f5718a6d0686239c47
 SHA512:
-  metadata.gz: 9d9244b466ec4823964e1b047cc3d4f7935571f2493eb890c6de4033f29f890c541157630767f9f09acd6c9224a70bf6f8fa8e1839c8b1b834422b492f829684
-  data.tar.gz: ea76d3f31b0aace96110dc3b28f3a0790bc9ed020bdb028c8fa19481c642b7a7e2bb3a787f977c7b0414950d3596c2bc859e69e92d49c8a92431369eeaeff574
+  metadata.gz: 8cdf494009273304c21956a32967e515b40f2dd711645f5b79208b018715018c0281ff2ef90c713aebf57cb85c5d08302336b8db432039d963f7e8745d9b2643
+  data.tar.gz: f412aa1a707430d7e0d6836170e904a628273f22455dab6ddd36173fff4dfd27e760f10e78a9e7fab15d5bd538779fefc4b7a3a5eb243be33248e49f1f7d3b93

data/.gitignore

@@ -6,7 +6,11 @@
 Gemfile.lock
 InstalledFiles
 _yardoc
+.idea/
+.idea/*
 coverage
+coverage/
+coverage/*
 doc/
 lib/bundler/man
 pkg

data/bin/bundle

@@ -0,0 +1,3 @@
+#!/usr/bin/env ruby
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../Gemfile', __FILE__)
+load Gem.bin_path('bundler', 'bundle')

data/bin/rails

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+APP_PATH = File.expand_path('../../config/application',  __FILE__)
+require_relative '../config/boot'
+require 'rails/commands'

data/bin/rake

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+require_relative '../config/boot'
+require 'rake'
+Rake.application.run

data/lib/rents/connection.rb

@@ -0,0 +1,90 @@
+module Rents
+  class Connection
+    # Attrs
+    attr_accessor :auth
+    attr_accessor :path
+    attr_accessor :domain
+    attr_accessor :end_point
+    attr_accessor :api_version
+    attr_accessor :request_params
+    attr_accessor :end_point_versioned
+
+    # Constructor
+    def initialize(params = {})
+      # Static part
+      self.request_params = {transaction:params}
+      setup_attrs(params)
+      setup_config
+      self.domain = 'localhost:7000' #'rents.pagerenter.com.br'
+      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?
+    end
+
+    # Full URL for the last request
+    def url_requested
+      "#{self.end_point}/#{self.api_version}/#{self.path}"
+    end
+
+    # ============== HTTP REQUESTs METHODs ==============
+    # GET
+    def get_request
+      RestClient.get self.url_requested
+    end
+
+    def get_json_request
+      return JSON.parse(RestClient.get(self.url_requested)).it_keys_to_sym
+    end
+
+    # POST
+    def post_request
+      RestClient.post self.url_requested, self.request_params
+    end
+
+    def post_json_request
+      return JSON.parse(RestClient.post(self.url_requested, self.request_params)).it_keys_to_sym
+    end
+
+    # CALLBACKs
+    private
+      # Config Attrs
+      def setup_config
+        self.auth = {app_id:Rents.app_id, secret_key:Rents.secret_key}
+        self.request_params.merge!(auth:self.auth)
+      end
+
+      # SetUp a default app
+      def setup_default_app
+        # setup test_app path
+        self.path = 'global_app'
+
+        # Get the App & setup config
+        app = get_json_request[:app]
+        Rents.app_id = app[:id]
+        Rents.secret_key = app[:secret]
+        self.auth = {app_id:Rents.app_id, secret_key:Rents.secret_key}
+        self.request_params.merge!(auth:self.auth)
+      end
+
+      # SetUp all attrs
+      def setup_attrs(params)
+        # Dynamic part
+        params.each do |key, value|
+          next unless key.to_s.index('[]').nil?
+          self.class.__send__(:attr_accessor, :"#{key}")
+          self.__send__("#{key}=", value)
+        end
+      end
+
+      # HTTPs must have '[]' on it key name to send Array
+      def custom_http_params
+        return if self.sold_items.nil?
+        self.sold_items.each_with_index do |sold_item, i|
+          self.request_params[:transaction]["sold_items[#{i}]"] = sold_item
+        end
+      end
+  end
+end

data/lib/rents/hash.rb

@@ -0,0 +1,55 @@
+# Override ruby Hash Obj
+class Hash
+  # Attr to be external accessible
+  attr_accessor :get_url_params
+
+  # Convert string keys to symbol keys
+  def it_keys_to_sym
+    self.keys.each do |key|
+      self[key].it_keys_to_sym if self[key].is_a?(Hash)
+      self[(key.to_sym rescue key) || key] = self.delete(key)
+    end
+
+    return self
+  end
+
+  # Convert it keys to get params
+  def it_keys_to_get_param
+    self.it_keys_to_sym
+    self.get_url_params = '?' if self.get_url_params.nil?
+
+    self.keys.each do |key|
+      self.get_url_params = self.get_url_params+'&' unless self.get_url_params.length == 1
+
+      # Nested obj_attrs
+      if self[key].is_a?(Hash)
+        hash_name = key
+        hash_obj = self[key]
+
+        # Hash to GET URL
+        param = to_nested_get_param hash_name, hash_obj
+      end
+
+      self.get_url_params = self.get_url_params+param
+    end
+
+    # Remove the last char: &
+    return self.get_url_params[0..self.get_url_params.length-2]
+  end
+
+  # SetUp a hash to hash URL GET
+  def to_nested_get_param  hash_name, hash_obj
+    # initial value
+    get_nested_params = ''
+
+    # foreach keys to mount the URL_PARAM
+    hash_obj.keys.each do |key|
+      key_param = hash_obj[key].to_nested_get_param key, hash_obj[key] if hash_obj[key].is_a?(Hash)
+      key_param = "#{hash_name}[#{key}]=#{hash_obj[key]}&" unless hash_obj[key].is_a?(Hash)
+      get_nested_params = get_nested_params+key_param
+    end
+
+    # return
+    get_nested_params
+  end
+end

data/lib/rents/status.rb

@@ -0,0 +1,28 @@
+module Rents
+  class Status < Rents::Connection
+    # Attrs
+    attr_accessor :message # API response message
+    attr_accessor :http_code # HTTP Code for the request
+    attr_accessor :api_code # Internal system response code
+
+    # Constructor
+    def initialize(params = {})
+      super # call it super initialize
+      self.path = "status"
+      check_it
+    end
+
+    # Check it status and "setup" it attrs
+    def check_it
+      self.path = 'status'
+      resp = get_request
+      hash_resp = JSON.parse(resp).it_keys_to_sym
+      self.http_code = resp.code
+      self.message = "EndPoint not response(connection error): #{self.url_requested}" if self.http_code != 200
+      self.message = hash_resp[:message] if self.http_code == 200
+      self.api_code = hash_resp[:api_code]
+
+      return self
+    end
+  end
+end

data/lib/rents/transaction.rb

@@ -0,0 +1,57 @@
+module Rents
+  # Transaction Obj, but can Abstract nested objs like Costumer
+  class Transaction < Rents::Connection
+    attr_accessor :resp
+    attr_accessor :status # can be API Status: self.status = Rents::Status.new OR/AND Transaction Status
+    attr_accessor :sold_items
+
+    # Constructor
+    def initialize(params = {})
+      super # super init call
+      # Base redirect_link if test_env is set (so the redirect is just appended)
+      self.redirect_link = "#{self.end_point_versioned}/transactions" if params[:test_env]
+    end
+
+    # Return it RID easily
+    def rid
+      self.resp[:rid]
+    end
+
+    # GET /api/transactions/:rid by it attr
+    def verify
+      auth_hash = {}
+      auth_hash[:auth] = self.request_params[:auth]
+      if self.rid.nil? then return {error:'RID not received'} else self.path = "transactions/#{self.rid}/#{auth_hash.it_keys_to_get_param}" end
+      return self.get_json_request
+    end
+
+    # POST /api/transactions/page return operator page URL, like the Cielo Page
+    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]
+
+      # dynamic path (it is written when a specific method use it)
+      self.path = "transactions/page"
+
+      # using json_request because need only the answer (do not use something like it HTTP Code)
+      self.resp = self.post_json_request unless full_resp
+      self.resp = self.post_request if full_resp
+      return self.resp
+    end
+
+    # TODO create charge works like a buy_store
+=begin
+    # POST /api/transactions
+    def charge_store
+      self.path = "transactions"
+      self.status = self.post_request
+    end
+=end
+
+    # ================ STATICs ================
+    # GET /api/transactions/:rid by the rid passed
+    def self.find rid
+    end
+  end
+end

data/lib/rents/version.rb

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

data/lib/rents.rb

@@ -1,9 +1,34 @@
-#require "rents/version"
+# Libs/Gems or Ruby classes
+require 'json'
+require 'curl'
+require 'rest_client'
+
+# Overrides
+require 'rents/hash'
+
+# Gem files
+require "rents/version"
+require "rents/connection"
+require "rents/status"
+require "rents/transaction"
 
 module Rents
-  class Transaction
-    def self.hi
-      puts 'Hi there!'
-    end
+  @@app_id = nil
+  @@secret_key = nil
+
+  def self.app_id=(app_id)
+    @@app_id = app_id
+  end
+
+  def self.app_id
+    @@app_id
+  end
+
+  def self.secret_key=(secret_key)
+    @@secret_key = secret_key
+  end
+
+  def self.secret_key
+    @@secret_key
   end
 end

data/modelagem/useful_files/card_operators/cielo/test_cards.txt

@@ -0,0 +1,11 @@
+BANDEIRA    |   Autenticação    |   Número Cartão   |   Validade    |   Cod. Segurança
+VISA        |       OK          |  4012001037141112 |    05/2018    |       123
+MASTER      |       OK          |  5453010000066167 |    05/2018    |       123
+VISA        |       NO          |  4012001038443335 |    05/2018    |       123
+MASTER      |       NO          |  5453010000066167 |    05/2018    |       123
+AMERICAN EXP|       NO          |  376449047333005  |    05/2018    |       1234
+ELO         |       NO          |  6362970000457013 |    05/2018    |       123
+DINNERS     |       NO          |  36490102462661   |    05/2018    |       123
+DISCOVER    |       NO          |  6011020000245045 |    05/2018    |       123
+JCB         |       NO          |  3566007770004971 |    05/2018    |       123
+AURA        |       NO          |5078601912345600019|    05/2018    |       123

data/modelagem/useful_files/card_operators/cielo/test_keys.txt

@@ -0,0 +1,3 @@
+Type        |   Membership number    |                          Access Key
+Store       |       1006993069       |  25fbb99741c739dd84d7b06ec78c9bac718838630f30b112d033ce2e621b34f3
+Cielo       |       1001734898       |  e84827130b9837473681c2787007da5914d6359947015a5cdb2b8843db0fa832

data/rents.gemspec

@@ -10,7 +10,7 @@ Gem::Specification.new do |spec|
   spec.email         = ["ilton_unb@hotmail.com"]
   spec.summary       = 'Rent$ payment Gateway & Intermediary ruby gem'
   spec.description   = 'Ruby gem for Rent$ payment Gateway & Intermediary'
-  spec.homepage      = "http://pagerenter.com.br/rents"
+  spec.homepage      = "http://pagerents.github.io/rents-sdk-ruby"
   spec.license       = "MIT"
 
   spec.files         = `git ls-files -z`.split("\x0")
@@ -20,4 +20,17 @@ Gem::Specification.new do |spec|
 
   spec.add_development_dependency "bundler", "~> 1.6"
   spec.add_development_dependency "rake"
+
+  # RSpec for tests
+  spec.add_development_dependency "rspec"
+  # Coverage
+  spec.add_development_dependency 'simplecov', '~> 0.7.1'
+  # Create readable attrs values
+  spec.add_development_dependency 'faker', '~> 1.4.2'
+  # For real user operator IP (4GeoLoc)
+  spec.add_dependency 'curb'
+  # HTTP REST Client
+  spec.add_dependency "rest-client"
+  # Easy JSON create
+  spec.add_dependency "multi_json"
 end

data/spec/helpers.rb

@@ -0,0 +1,23 @@
+module Helpers
+  def accessible? url
+    resp = RestClient.get url
+    resp.code == 200 ? true : false
+  end
+
+  def fake_sold_items
+    sold_items = []
+
+    count = 0
+    items_amount = 3
+
+    until count == items_amount do
+      count = count+1
+      sold_items.push({
+          remote_id: Faker::Number.number(count),
+          name: Faker::Commerce.product_name
+      })
+    end
+
+    return sold_items
+  end
+end

data/spec/rents/rents_spec.rb

@@ -0,0 +1,12 @@
+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

data/spec/rents/status_spec.rb

@@ -0,0 +1,12 @@
+require 'spec_helper'
+
+describe Rents::Status do
+  describe 'API' do
+    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

data/spec/rents/transaction_spec.rb

@@ -0,0 +1,94 @@
+require 'spec_helper'
+
+describe Rents::Transaction do
+  # OK Operator Page tests
+  describe '(SUCCESS REQUEST) Operator - BuyPage' do
+    # ================    SetUp/Config    ================
+    before(:all) do
+      base_url = 'http://localhost:7000'
+
+      @api_status = Rents::Status.new({
+        test_env:true
+      })
+
+      @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
+      })
+
+      # Fake SoldItems added
+      @page_transaction.sold_items = fake_sold_items
+
+      # Send BuyPage
+      @page_resp = @page_transaction.charge_page
+    end
+
+    # ================    Tests/Expects/Should   ================
+    it 'resp should not be null' do
+      @page_resp.should_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
+    end
+
+    it 'resp should be an accessible Operator URL' do
+      url = @page_resp['purchase_url']
+      url = @page_resp[:purchase_url] if url.nil?
+
+      url.should_not be_nil
+      be_accessible(url).should be_true
+    end
+
+    it 'must be verifiable' do
+      # SetUps
+      verify_resp = @page_transaction.verify
+      error = verify_resp[:error]
+      error = verify_resp['error'] if error.nil?
+
+      # Validations
+      verify_resp.should_not be_nil
+      error.should 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
+    end
+  end
+
+  # NOT_OK Operator Page tests
+  describe '(BAD REQUEST) Operator - BuyPage' do
+    # SetUp/Config
+    before(:each) do
+      Rents.app_id = 1
+      Rents.secret_key = '12312321312$2a$10$NmV9EysKVLe8ItBdl9CHN.LF05bOuDdoOkmfptdbJs7cuaDWksuUu'
+      base_url = 'http://localhost:7000'
+
+      # Not using test_env (so using a app passed not the global app)
+      @page_transaction = Rents::Transaction.new({
+        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
+      })
+
+      # Send BuyPage
+      @page_resp = @page_transaction.charge_page(full_resp=true)
+    end
+
+    it 'must have some error' do
+      # SetUp vars
+      json_resp = JSON.parse(@page_resp)
+      error = json_resp[:error]
+      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
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,18 @@
+require 'bundler/setup'
+require 'rest_client'
+require './spec/helpers'
+
+Bundler.setup
+
+require 'simplecov'
+SimpleCov.start do
+end
+
+# and any other gems you need
+require 'rents'
+require 'faker'
+
+RSpec.configure do |c|
+  # some (optional) config here
+  c.include Helpers
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rents
 version: !ruby/object:Gem::Version
-  version: 0.0.0
+  version: 0.1.0
 platform: ruby
 authors:
 - Ilton Garcia
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-09-16 00:00:00.000000000 Z
+date: 2014-10-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -38,10 +38,97 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  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: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.7.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.7.1
+- !ruby/object:Gem::Dependency
+  name: faker
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.4.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.4.2
+- !ruby/object:Gem::Dependency
+  name: curb
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rest-client
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: multi_json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Ruby gem for Rent$ payment Gateway & Intermediary
 email:
 - ilton_unb@hotmail.com
-executables: []
+executables:
+- bundle
+- rails
+- rake
 extensions: []
 extra_rdoc_files: []
 files:
@@ -50,10 +137,26 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
+- bin/bundle
+- bin/rails
+- bin/rake
 - lib/rents.rb
+- lib/rents/connection.rb
+- lib/rents/hash.rb
+- lib/rents/status.rb
+- lib/rents/transaction.rb
 - lib/rents/version.rb
+- modelagem/Sequence - APIClient.asta
+- modelagem/Structure - ClassDiagram.asta
+- modelagem/useful_files/card_operators/cielo/test_cards.txt
+- modelagem/useful_files/card_operators/cielo/test_keys.txt
 - rents.gemspec
-homepage: http://pagerenter.com.br/rents
+- spec/helpers.rb
+- spec/rents/rents_spec.rb
+- spec/rents/status_spec.rb
+- spec/rents/transaction_spec.rb
+- spec/spec_helper.rb
+homepage: http://pagerents.github.io/rents-sdk-ruby
 licenses:
 - MIT
 metadata: {}
@@ -77,4 +180,9 @@ rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
 summary: Rent$ payment Gateway & Intermediary ruby gem
-test_files: []
+test_files:
+- spec/helpers.rb
+- spec/rents/rents_spec.rb
+- spec/rents/status_spec.rb
+- spec/rents/transaction_spec.rb
+- spec/spec_helper.rb