kamba_checkout 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 0277e0eb7550877cc851049ec1cf7d21e2d7e23a535f6c108f23eca17d82e4de
+  data.tar.gz: 96889802bc7f22e45cd3265fb8818493c4a9d4af88087b18d1f68291e11439f3
+SHA512:
+  metadata.gz: a7d7d09ddc90d6c25f3358f44e53acbad9227adf93084f00490f460147f27a192d0389bd51b04936f8f1f7c003aa73aab4f6075f75c0b67cc0715d446fe9faa1
+  data.tar.gz: ce6c43de752cfacece25073bac41af93ae4ef5408e4053366e5ab15acbe24ecd1935d0b6d04563fae90e3647e1b8df302b0f625c8e6d675597cbfae20a466f0a

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.ruby-version

@@ -0,0 +1 @@
+2.5.1

data/Gemfile

@@ -0,0 +1,6 @@
+source 'https://rubygems.org'
+
+group :development do
+  gem "rspec"
+  gem "rake"
+end

data/Gemfile.lock

@@ -0,0 +1,28 @@
+GEM
+  remote: https://rubygems.org/
+  specs:
+    diff-lcs (1.3)
+    rake (12.3.2)
+    rspec (3.8.0)
+      rspec-core (~> 3.8.0)
+      rspec-expectations (~> 3.8.0)
+      rspec-mocks (~> 3.8.0)
+    rspec-core (3.8.0)
+      rspec-support (~> 3.8.0)
+    rspec-expectations (3.8.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-mocks (3.8.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-support (3.8.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  rake
+  rspec
+
+BUNDLED WITH
+   1.17.1

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 Herneto
+
+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,98 @@
+# KambaCheckout
+
+Gem ruby para configurar o checkout nos serviços da Kamba.
+## Instalação
+
+Adicione essa linha ao Gemfile da sua applicação:
+
+```ruby
+gem 'kamba_checkout'
+```
+
+E execute:
+
+    $ bundle
+
+ou instale por você mesmo:
+
+    $ gem install kamba_checkout
+
+## Configuração
+
+```ruby
+require 'kamba_checkout'
+
+KambaCheckout.api_key = 'sua-chave-da-api-kamba'
+KambaCheckout.secret_key = 'sua-chave-secreta-kamba'
+```
+
+Ou simplesmente atribua os valores das suas chaves as seguintes variáveis de ambiente: `ENV["KAMBA_API_KEY"]` e `ENV["KAMBA_SECRET_KEY"]`.
+
+Usando Ruby on Rails? Coloque isso em config/initializers em novo arquivo chamado kamba_checkout.rb.
+
+## Uso
+
+```ruby
+checkout_config = {
+            "channel"=>"WEB",
+            "initial_amount"=>10000,
+            "notes"=> "Curso API Iniciantes",
+            "redirect_url_success"=>"https://seusite.com/curso/api-iniciantes"
+      }
+@checkout = KambaCheckout::API.generate_checkout('KAMBA-API-MODE', checkout_config)
+```
+Obs: `KAMBA-API-MODE: sandbox, staging ou production`
+
+
+**Configurações `checkout_config`:**
+- Para o nosso propósito o valor do campo `channel`, permanecerá igual à **WEB** como no exemplo.
+- `initial_amount`, este campo recebe o preço do produto ou serviço a ser comercializado.
+- Substitua o valor do campo `notes` por uma anotação ou descrição geral a cerca do pagamento, e coloque o preço do mesmo no valor do campo `initial_amount`.
+- O campo `redirect_url_success` recebe o endereço da página na qual pretende-se ser redirecionada após o pagamento com sucesso.
+
+## Usando Ruby on Rails?
+
+Coloque o código acima na action que renderiza a página que vai conter o checkout e siga as instruções:
+
+**Passo 1:**
+## Página do comerciante
+Faça a chamada à biblioteca no cabeçalho da sua página Web ou no corpo da página antes das outras configurações javascript que poderão ser configuradas:
+
+```html
+<head>       
+  <script src="http://comerciante.usekamba.com/checkout/0.0.1/kamba-web-sdk.js" charset="utf-8"></script>
+</head>
+```
+
+**Passo 2:**
+Faça a inclusão do botão "Pagar com KAMBA" dentro do corpo da sua página Web em qualquer lugar onde desejar que o botão seja apresentado.
+
+```html
+<body>
+  <button class="btnOpenWidgetKamba" onclick="start_payment()"></button>
+</body>
+```
+
+**Passo 3:**
+Cole o código abaixo dentro da tag html `<body></body>` no corpo da sua página Web, de preferência no final da página.
+
+```html
+<body>
+   <script type="text/javascript">
+    function start_payment() {
+      kamba(api_config = {
+    	  environment: '<%= @checkout.environment %>', // Use variável de ambiente para segurança.
+    	  api_key: '<%= @checkout.api_key %>', // Use variável de ambiente para segurança.
+        checkout_time: '<%= @checkout.time %>',
+        checkout_signature: '<%= @checkout.signature %>'
+    	},
+    	checkout_config = {
+        channel: '<%= @checkout.channel %>',
+        initial_amount: <%= @checkout.initial_amount %>,
+        notes: '<%= @checkout.notes %>',
+        redirect_url_success: '<%= @checkout.redirect_url_success %>'
+     });
+    }
+  </script>
+  </script>
+</body>

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "kamba_checkout"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/kamba_checkout.gemspec

@@ -0,0 +1,23 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "kamba_checkout/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "kamba_checkout"
+  spec.version       = KambaCheckout::VERSION
+  spec.authors       = ["Hernani Neto"]
+  spec.email         = ["hernaniprogramacao@gmail.com"]
+
+  spec.summary       = %q{Kamba Checkout}
+  spec.description   = %q{A gem to generate signatures based on your Kamba secret Key to use Kamba Checkout Js.}
+  spec.homepage      = "https://github.com/usekamba/kamba_checkout_ruby"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split("\n")
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.17"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

data/lib/kamba_checkout.rb

@@ -0,0 +1,13 @@
+require "kamba_checkout/version"
+
+module KambaCheckout
+  require 'time'
+  require 'json'
+  require 'digest'
+  require 'openssl'
+  require 'base64'
+
+  require 'kamba_checkout/model/response'
+  require 'kamba_checkout/api'
+  require 'kamba_checkout/config'
+end

data/lib/kamba_checkout/api.rb

@@ -0,0 +1,22 @@
+module KambaCheckout
+  class API
+    def self.generate_checkout(environment, checkout)
+      time = Time.now.httpdate
+      secret_key = KambaCheckout.secret_key
+
+      json_string = checkout.to_json
+      canonical_string = "POST,application/json,#{generate_md5(json_string)},#{'/v1/checkouts'},#{time}"
+      digest = OpenSSL::Digest.new('sha1')
+
+      hmac_signature = OpenSSL::HMAC.digest(digest, secret_key, canonical_string)
+      signature = Base64.strict_encode64(hmac_signature)
+      KambaCheckout::Response.new(environment, checkout, signature, time)
+    end
+
+    private
+
+    def self.generate_md5(checkout)
+      Digest::MD5.base64digest(checkout)
+    end
+  end
+end

data/lib/kamba_checkout/config.rb

@@ -0,0 +1,19 @@
+module KambaCheckout
+  class << self
+    def secret_key=(key)
+      @secret_key= key
+    end
+
+    def secret_key
+      @secret_key || ENV["KAMBA_SECRET_KEY"]
+    end
+
+    def api_key=(key)
+      @api_key= key
+    end
+
+    def api_key
+      @api_key || ENV["KAMBA_API_KEY"]
+    end
+  end
+end

data/lib/kamba_checkout/model/response.rb

@@ -0,0 +1,15 @@
+module KambaCheckout
+  class Response
+    attr_accessor :signature, :time, :environment, :checkout_config, :api_key, :channel, :initial_amount, :notes, :redirect_url_success
+    def initialize(environment, checkout, signature, time)
+      @environment = environment
+      @channel = checkout['channel']
+      @initial_amount = checkout['initial_amount']
+      @notes = checkout['notes']
+      @redirect_url_success = checkout['redirect_url_success']
+      @signature = signature
+      @time = time
+      @api_key = KambaCheckout.api_key
+    end
+  end
+end

data/lib/kamba_checkout/version.rb

@@ -0,0 +1,3 @@
+module KambaCheckout
+  VERSION = "0.1.0"
+end

data/spec/api_spec.rb

@@ -0,0 +1,21 @@
+describe 'KambaCheckout::API' do
+  describe 'Generating Signature' do
+    before(:each) do
+      @checkout = {
+        'channel'=>'WEB',
+        'initial_amount'=>5500,
+        'notes'=> 'Alguma note exemplo.',
+        'redirect_url_success'=> 'http://amarildolucas.com/curso/aplicativo-movel-com-swift/sucesso'
+      }
+      KambaCheckout.secret_key = '123'
+    end
+
+    it 'should generate signature' do
+      user = KambaCheckout::API.generate_signature('sandbox', @checkout)
+      user.time.should == Time.now.httpdate
+      user.signature.should_not == '123'
+      user.environment.should == 'sandbox'
+      user.checkout_config = @checkout.to_json
+    end
+  end
+end

data/spec/config_spec.rb

@@ -0,0 +1,47 @@
+require 'spec_helper'
+
+describe 'KambaCheckout' do
+  describe 'secret_key' do
+    before(:each) do
+      @default_secret_key = KambaCheckout.secret_key
+      KambaCheckout.secret_key = nil
+      ENV['KAMBA_SECRET_KEY'] = nil
+    end
+
+    after(:each) do
+      KambaCheckout.secret_key = @default_secret_key
+      KambaCheckout.api_key = @default_sec_key
+    end
+
+    it 'should set and read instance variable' do
+      KambaCheckout.secret_key = '123'
+      KambaCheckout.secret_key.should == '123'
+    end
+
+    it 'should fallback to ENV variable' do
+      ENV['KAMBA_SECRET_KEY'] = 'checkout'
+      KambaCheckout.secret_key.should == 'checkout'
+    end
+  end
+  describe 'api_key' do
+    before(:each) do
+      @default_api_key = KambaCheckout.api_key
+      KambaCheckout.api_key = nil
+      ENV['KAMBA_API_KEY'] = nil
+    end
+
+    after(:each) do
+      KambaCheckout.api_key = @default_api_key
+    end
+
+    it 'should set and read instance variable' do
+      KambaCheckout.api_key = '123'
+      KambaCheckout.api_key.should == '123'
+    end
+
+    it 'should fallback to ENV variable' do
+      ENV['KAMBA_API_KEY'] = 'checkout'
+      KambaCheckout.api_key.should == 'checkout'
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,3 @@
+require "bundler/setup"
+require "kamba_checkout"
+require 'rspec'

metadata

@@ -0,0 +1,106 @@
+--- !ruby/object:Gem::Specification
+name: kamba_checkout
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Hernani Neto
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-01-17 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+- !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'
+description: A gem to generate signatures based on your Kamba secret Key to use Kamba
+  Checkout Js.
+email:
+- hernaniprogramacao@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".ruby-version"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- kamba_checkout.gemspec
+- lib/kamba_checkout.rb
+- lib/kamba_checkout/api.rb
+- lib/kamba_checkout/config.rb
+- lib/kamba_checkout/model/response.rb
+- lib/kamba_checkout/version.rb
+- spec/api_spec.rb
+- spec/config_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/usekamba/kamba_checkout_ruby
+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.7.6
+signing_key: 
+specification_version: 4
+summary: Kamba Checkout
+test_files: []