kamba_signature_generation 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 424b8cc32a1b716be1534c2e4d18a591e986585da04a1356d4ed33c52f9e3269
+  data.tar.gz: 605bac9153aa96a4be97b132d2451da907d031d47094bafc0bd45ba3ed35f308
+SHA512:
+  metadata.gz: e08b4dbe91be7828cb42a3996e229e0495d4199bc94dab771e8f8b459b4587ab3b73bee7ffeedc0be6994fa068b4cfa30a70500be75b6b319eddb514478cd9f9
+  data.tar.gz: a8ae6353e7063156d3aedc7eb3cf745470d9b145d5fea49d7b63c7238d86f44c3234165bc73c81202c506a313a27faa42314e252d343ccde9311214eb51b8382

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,52 @@
+# Kamba Signature Generation
+
+Gem ruby para gerar a assinatura necessária para processar o checkout nos serviços da Kamba.
+## Instalação
+
+Adicione essa linha ao Gemfile da sua applicação:
+
+```ruby
+gem 'kamba_signature_generation'
+```
+
+E execute:
+
+    $ bundle
+
+ou instale por você mesmo:
+
+    $ gem install kamba_signature_generation
+
+## Configuração
+
+```ruby
+require 'kamba_signature_generation'
+
+KambaSignatureGeneration.secret_key = 'sua-chave-secreta-kamba'
+```
+
+Ou simplesmente atribua o valor da sua chaves-chave-kamba secreta a seguinte variável de ambiente: `ENV["KAMBA_SECRET_KEY"]`.
+
+Usando Ruby on Rails? Coloque isso em config/initializers em novo arquivo chamado kamba_signature_generation.rb.
+
+## Uso
+
+```ruby
+checkout_config = {
+            "channel"=>"WEB",
+            "initial_amount"=>10000,
+            "notes"=> "Curso API Iniciantes",
+            "redirect_url_success"=>"https://seusite.com/curso/api-iniciantes"
+      }
+@signature = KambaSignatureGeneration::API.generate_signature('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.
+
+Finalmente, use o valor de `@signature` para assinar processar o checkout.

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_signature_generation"
+
+# 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_signature_generation.gemspec

@@ -0,0 +1,24 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "kamba_signature_generation/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "kamba_signature_generation"
+  spec.version       = KambaSignatureGeneration::VERSION
+  spec.authors       = ["Hernani Neto"]
+  spec.email         = ["hernaniprogramacao@gmail.com"]
+
+
+  spec.summary       = %q{Kamba Signature Generation}
+  spec.description   = %q{A gem to generate signatures based on your Kamba secret key to use with Kamba Checkout Js.}
+  spec.homepage      = "https://github.com/usekamba/generate-signature-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_signature_generation.rb

@@ -0,0 +1,14 @@
+require "kamba_signature_generation/version"
+
+module KambaSignatureGeneration
+  class Error < StandardError; end
+
+  require 'time'
+  require 'json'
+  require 'digest'
+  require 'openssl'
+  require 'base64'
+
+  require 'kamba_signature_generation/api'
+  require 'kamba_signature_generation/config'
+end

data/lib/kamba_signature_generation/api.rb

@@ -0,0 +1,18 @@
+module KambaSignatureGeneration
+  class API
+    def self.generate_signature(checkout)
+      secret_key = KambaSignatureGeneration.secret_key
+
+      json_string = checkout.to_json
+      canonical_string = "POST,application/json,#{generate_md5(json_string)},#{'/v1/checkouts'}"
+
+      digest = OpenSSL::Digest.new('sha1')
+      hmac_signature = OpenSSL::HMAC.digest(digest, secret_key, canonical_string)
+      Base64.strict_encode64(hmac_signature)
+    end
+
+    def self.generate_md5(checkout)
+      Digest::MD5.base64digest(checkout)
+    end
+  end
+end

data/lib/kamba_signature_generation/config.rb

@@ -0,0 +1,11 @@
+module KambaSignatureGeneration
+  class << self
+    def secret_key=(key)
+      @secret_key= key
+    end
+
+    def secret_key
+      @secret_key || ENV["KAMBA_SECRET_KEY"]
+    end
+  end
+end

data/lib/kamba_signature_generation/version.rb

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

data/spec/api_spec.rb

@@ -0,0 +1,20 @@
+require 'spec_helper'
+
+describe 'KambaSignatureGeneration::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'
+      }
+      KambaSignatureGeneration.secret_key = '123'
+    end
+
+    it 'should generate signature' do
+      signature = KambaSignatureGeneration::API.generate_signature(@checkout)
+      signature.should_not == '123'
+    end
+  end
+end

data/spec/config_spec.rb

@@ -0,0 +1,25 @@
+
+
+describe 'KambaSignatureGeneration' do
+  describe 'secret_key' do
+    before(:each) do
+      @default_secret_key = KambaSignatureGeneration.secret_key
+      KambaSignatureGeneration.secret_key = nil
+      ENV['KAMBA_SECRET_KEY'] = nil
+    end
+
+    after(:each) do
+      KambaSignatureGeneration.secret_key = @default_secret_key
+    end
+
+    it 'should set and read instance variable' do
+      KambaSignatureGeneration.secret_key = '123'
+      KambaSignatureGeneration.secret_key.should == '123'
+    end
+
+    it 'should fallback to ENV variable' do
+      ENV['KAMBA_SECRET_KEY'] = 'checkout'
+      KambaSignatureGeneration.secret_key.should == 'checkout'
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,4 @@
+require "bundler/setup"
+require "kamba_signature_generation"
+
+require 'rspec'

metadata

@@ -0,0 +1,102 @@
+--- !ruby/object:Gem::Specification
+name: kamba_signature_generation
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Hernani Neto
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-01-18 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 with
+  Kamba Checkout Js.
+email:
+- hernaniprogramacao@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- kamba_signature_generation.gemspec
+- lib/kamba_signature_generation.rb
+- lib/kamba_signature_generation/api.rb
+- lib/kamba_signature_generation/config.rb
+- lib/kamba_signature_generation/version.rb
+- spec/api_spec.rb
+- spec/config_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/usekamba/generate-signature-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 Signature Generation
+test_files: []