kiik 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: fc35f97e2e5b4201b86040593b4615a86ab5e4b9
+  data.tar.gz: 09f7abbdad3b0df36f2e557a8d6f4b5cff2eaf79
+SHA512:
+  metadata.gz: 85878db1fae575fd44bfd4a04c09f6b50c698a6fd1c3e35a8cab2cdeaafcd998ae0afc951ac026256452f0fbf3ef043be31cef6f9e9d8cdefbe22fadc5932455
+  data.tar.gz: 35cfec56927bc99612b9283ad683acd71f287a8eca8603710923d294f2a11bb0cb534ad8f20ac1de183d0f5f101bbd10f910394c11850fade751756bce814df6

data/.gitignore

@@ -0,0 +1 @@
+kiik-*.gem

data/Gemfile

@@ -0,0 +1,4 @@
+source "https://rubygems.org"
+gemspec
+
+gem 'httparty', '>= 0.13.7'

data/README.md

@@ -0,0 +1,42 @@
+# KiiK Ruby [![Codeship Status for kiik-payments/kiik_ruby](https://codeship.com/projects/893b1600-608e-0133-73dd-7258394f756c/status?branch=master)](https://codeship.com/projects/112216) [![Inline docs](http://inch-ci.org/github/kiik-payments/kiik-ruby.svg?branch=master)](http://inch-ci.org/github/kiik-payments/kiik-ruby)
+
+Gem for bindings with Kiik API
+
+Requirements
+--------------
+* ruby    >= 2.2.3
+* httpaty >= 0.13.7
+
+Installation
+--------------
+### Gem
+   `gem install kiik`
+
+### Bundle
+```ruby
+source 'https://rubygems.org'
+gem 'kiik'
+```
+
+Tasks
+-----
+### Configuration
+Kiik gem use config file `config/kiik.yml` for take api_key
+For create this file in your project use task:
+
+```
+rake kiik:config
+```
+
+Don't forget to change `api_key` to your key
+
+### Use
+
+```ruby
+#Create customer
+customer = Kiik::Customer.create({name: "User name", email: "user@email.com"})
+```
+
+### Production
+
+For production env, don't forget to set `KIIK_ENV` to `production`, that way, our gem will read the `kiik.yml` file corretly.

data/Rakefile

@@ -0,0 +1,8 @@
+require 'rake/testtask'
+
+task :default => [:test]
+
+Rake::TestTask.new do |t|
+  t.pattern = './test/**/*_test.rb'
+end
+import 'lib/tasks/kiik.rake'

data/config/kiik.yml

@@ -0,0 +1,12 @@
+development:
+  api_key:  payos_kiik
+  host:     http://localhost:8800
+  version:  0.1.0
+staging:
+  api_key:  B31DCE74-E768-43ED-86DA-85501612548F
+  host:     https://demo.kiik.com
+  version:  0.1.0
+production:
+  api_key:  B31DCE74-E768-43ED-86DA-85501612548F
+  host:     https://api.kiik.com
+  version:  0.1.0

data/kiik.gemspec

@@ -0,0 +1,22 @@
+$:.unshift(File.join(File.dirname(__FILE__), 'lib'))
+
+spec = Gem::Specification.new do |s|
+  s.name = 'kiik'
+  s.version = '0.1.0'
+  s.summary = 'Integrate Kiik with your Ruby app'
+  s.description = "KiiK's official gem that helps you to integrate with our services. See https://docs.kiik.com.br for details."
+  s.authors = ['Julien Lucca', 'Esdras Eduardo']
+  s.email = ['lucca@kiik.com', 'esdras.rosa@kiik.com']
+  s.homepage = 'http://docs.kiik.com'
+  s.license = 'MIT'
+
+  s.add_development_dependency('mocha', '~> 0.13')
+  s.add_development_dependency('shoulda', '~> 3.5')
+  s.add_development_dependency('test-unit', '~> 3.1')
+  s.add_development_dependency('rake', '~> 10.4')
+  s.add_development_dependency('webmock', '~> 1.21.0')
+
+  s.files = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- test/*`.split("\n")
+  s.require_paths = ['lib']
+end

data/lib/kiik.rb

@@ -0,0 +1,32 @@
+require 'yaml'
+require 'httparty'
+
+require 'kiik/rest/create'
+require 'kiik/util'
+require 'kiik/resource'
+require 'kiik/card'
+require 'kiik/customer'
+require 'kiik/charge'
+require 'kiik/error'
+
+module Kiik
+  relative_config = '../config/kiik.yml'
+  path = File.expand_path(relative_config, ENV["BUNDLE_GEMFILE"])
+
+  unless File.exist? path
+    puts "Warning: Config file not exist (#{path}), try `rake kiik:config`, using DEMO by default"
+    path = File.expand_path("../#{relative_config}", __FILE__)
+  end
+
+  config = YAML.load_file(path)
+  env = ENV['KIIK_ENV'] || 'development'
+
+  @host = config[env]['host']
+  @version = config[env]['version']
+  @api_key = config[env]['api_key']
+
+  class << self
+    attr_accessor :api_key, :host, :version
+  end
+
+end

data/lib/kiik/card.rb

@@ -0,0 +1,7 @@
+module Kiik
+  class Card < Resource
+    include Kiik::Rest::Create
+
+    attr_accessor :customer_id, :name, :number, :month, :year, :cvc, :card_alias
+  end
+end

data/lib/kiik/charge.rb

@@ -0,0 +1,7 @@
+module Kiik
+  class Charge < Resource
+    include Kiik::Rest::Create
+
+    attr_accessor :customer, :amount, :receipt_email, :destination, :description, :statement_descriptor, :status
+  end
+end

data/lib/kiik/customer.rb

@@ -0,0 +1,24 @@
+module Kiik
+  class Customer < Resource
+    include Kiik::Rest::Create
+
+    attr_accessor :phone, :name, :document, :email, :metadata, :description, :cards
+
+    def initialize(attributes = {})
+      super(attributes)
+      @cards = @cards.nil? ? [] : @cards.map{ |card| Card.new(card) }
+    end
+
+    def to_json
+      super.merge!(super([
+        :phone,
+        :name,
+        :document,
+        :email,
+        :metadata,
+        :description,
+        :cards
+      ]))
+    end
+  end
+end

data/lib/kiik/error.rb

@@ -0,0 +1,12 @@
+module Kiik
+  class KiikError < StandardError
+    attr_reader :errors
+    def initialize(body)
+      @errors = [{attr: body['error']['param'], message: body['error']['message']}]
+    end
+
+    def to_s
+      @errors.map{ |e| e[:message] }.join(", ")
+    end
+  end
+end

data/lib/kiik/resource.rb

@@ -0,0 +1,51 @@
+module Kiik
+  class Resource
+    include HTTParty
+
+    attr_accessor :id, :created, :errors
+
+    class << self
+      def class_name
+        self.name.split('::')[-1]
+      end
+
+      def url
+        "#{Kiik.host}/#{Kiik::Util.underscore(class_name)}s"
+      end
+
+      def opts
+        {
+          basic_auth: {username: Kiik.api_key, password: ''},
+          headers: {
+            "Accept-Version" => Kiik.version,
+            "Content-Type" => 'application/json'
+          }
+        }
+      end
+
+      def build(data, error = nil)
+        instance = self.new(data)
+        instance.errors = error.errors unless error.nil?
+        instance
+      end
+    end
+
+    def initialize(attributes = {})
+      attributes.each{ |name, value| self.instance_variable_set("@#{name}", value) }
+      self.errors = []
+    end
+
+    def valid?
+      self.errors.empty?
+    end
+
+    def to_json(attrs = [:id, :created])
+      result = {}
+      attrs.each{ |attr|
+        value = self.instance_variable_get("@#{attr}")
+        result[attr] = value unless value.nil? or value.empty?
+      }
+      result
+    end
+  end
+end

data/lib/kiik/rest/create.rb

@@ -0,0 +1,57 @@
+module Kiik
+  module Rest
+    module Create
+      class << self
+        def included(base)
+          base.extend(ClassMethods)
+        end
+      end
+
+      module ClassMethods
+        def create!(params={})
+          begin
+            create(params)
+          rescue KiikError => e
+            build(params, e)
+          rescue StandardError => e
+            e
+          end
+        end
+
+        def create(params={})
+          result = request(params)
+          raise result if result.instance_of? StandardError or result.instance_of? KiikError
+          result
+        end
+
+        def request(params)
+          options = opts.merge!({:body => JSON.generate(params)})
+          response = post url, options
+          response.body
+          case response.code
+          when 200
+            build(JSON.parse(response.body))
+          when 422
+            KiikError.new(JSON.parse(response.body))
+          else
+            StandardError.new(response.message)
+          end
+        end
+      end
+
+      def create
+        created = false
+        result = self.class.request(self.to_json)
+        if result.instance_of? KiikError
+          self.errors = result.errors
+        elsif result.instance_of? StandardError
+          raise result
+        else
+          initialize(result.to_json)
+          created = true
+        end
+        created
+      end
+    end
+  end
+end

data/lib/kiik/rest/update.rb

@@ -0,0 +1,57 @@
+module Kiik
+  module Rest
+    module Update
+      class << self
+        def included(base)
+          base.extend(ClassMethods)
+        end
+      end
+
+      module ClassMethods
+        def update!(params={})
+          begin
+            update(params)
+          rescue KiikError => e
+            build(params, e)
+          rescue StandardError => e
+            e
+          end
+        end
+
+        def update(params={})
+          result = request(params)
+          raise result if result.instance_of? StandardError or result.instance_of? KiikError
+          result
+        end
+
+        def request(params)
+          options = opts.merge!({:body => JSON.generate(params)})
+          response = post url + "/" + params[:id], options
+          response.body
+          case response.code
+          when 200
+            build(JSON.parse(response.body))
+          when 422
+            KiikError.new(JSON.parse(response.body))
+          else
+            StandardError.new(response.message)
+          end
+        end
+      end
+
+      def updated
+        updated = false
+        result = self.class.request(self.to_json)
+        if result.instance_of? KiikError
+          self.errors = result.errors
+        elsif result.instance_of? StandardError
+          raise result
+        else
+          initialize(result.to_json)
+          updated = true
+        end
+        updated
+      end
+    end
+  end
+end

data/lib/kiik/util.rb

@@ -0,0 +1,15 @@
+module Kiik
+  module Util
+    class << self
+      def underscore(camel_cased_word)
+        camel_cased_word.
+          gsub(/([A-Z]+)([A-Z][a-z])/,'\1_\2').
+          gsub(/([a-z\d])([A-Z])/,'\1_\2').
+          tr('-', '_').
+          gsub(/\s/, '_').
+          gsub(/__+/, '_').
+          downcase
+      end
+    end
+  end
+end

data/lib/tasks/kiik.rake

@@ -0,0 +1,14 @@
+namespace :kiik do
+  desc 'Create config file for kiik'
+  task :config do
+    relative_config = 'config/kiik.yml'
+    src = File.expand_path("../../../#{relative_config}", __FILE__)
+    dst = File.expand_path(relative_config, ENV["BUNDLE_GEMFILE"])
+    unless File.exist? dst
+      FileUtils.cp src, dst
+      puts "Config file created"
+    else
+      puts "Config file already exists"
+    end
+  end
+end

data/test/kiik/card_test.rb

@@ -0,0 +1,6 @@
+require File.expand_path('../../test_helper', __FILE__)
+
+module Kiik
+  class CardTest < Test::Unit::TestCase
+  end
+end

data/test/kiik/charge_test.rb

@@ -0,0 +1,6 @@
+require File.expand_path('../../test_helper', __FILE__)
+
+module Kiik
+  class ChargeTest < Test::Unit::TestCase
+  end
+end

data/test/kiik/customer_test.rb

@@ -0,0 +1,46 @@
+require File.expand_path('../../test_helper', __FILE__)
+
+module Kiik
+  class CustomerTest < Test::Unit::TestCase
+
+    should "raise exception for create empty customer" do
+      error = {type:"invalid_request_error", param:"name", message:"Param name is required"}
+      make_customer({}, error)
+      assert_raise KiikError do
+        Kiik::Customer.create
+      end
+    end
+
+    should "return invalid customer for create! empty customer" do
+      error = {type:"invalid_request_error", param:"name", message:"Param name is required"}
+      make_customer({}, error)
+      customer = Kiik::Customer.create!
+      assert !customer.valid?
+    end
+
+    should "return a new customer for create" do
+      data = {name:"Customer test", email:"customer@email.com", phone: "11223344", document:"11122233345"}
+      make_customer data
+      customer = Kiik::Customer.create data
+      assert customer.valid?
+      assert customer.cards.empty?
+    end
+
+    should "return a new customer with card for create with card" do
+      card_data = {name:"Card Name", number:"1234567890", month:12, year:17}
+      customer_data = {name:"Customer test", email:"customer@email.com", phone: "11223344", document:"11122233345", card:card_data}
+      make_customer customer_data
+      customer = Kiik::Customer.create customer_data
+      assert customer.valid?
+      assert customer.cards[0].name == card_data[:name]
+    end
+
+    should "return customer for create using instance" do
+      data = {name:"Customer test", email:"customer@email.com", phone: "11223344", document:"11122233345"}
+      make_customer data
+      customer = Kiik::Customer.new data
+      customer.create
+      assert customer.valid?
+    end
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,15 @@
+require 'kiik'
+require 'test/unit'
+require 'mocha/setup'
+require 'shoulda'
+require 'webmock/test_unit'
+require File.expand_path('../test_mock.rb', __FILE__)
+
+class Test::Unit::TestCase
+  include Mocha
+  include Kiik::TestMock
+
+  setup do
+  end
+
+end

data/test/test_mock.rb

@@ -0,0 +1,20 @@
+module Kiik
+  module TestMock
+
+    def request(url, params = {}, method = :any)
+      host = Kiik.host.gsub(/^https:\/\//, "").gsub(/^http:\/\//, "")
+      headers = {:accept_version => Kiik.version, :content_type => 'application/json'}
+      stub_request(method, "#{Kiik.api_key}:@#{host}/#{url}").
+        with(:headers => headers).
+        with(:body => params)
+    end
+
+    def make_customer(params = {}, error = nil)
+      code = error.nil? ? 200 : 422
+      respond = error.nil? ? params.clone : {error: error}
+      respond[:cards] = [params[:card]] unless params[:card].nil?
+      request("customers", params, :post).
+        to_return(:status => code, :body => JSON.generate(respond), :headers => {})
+    end
+  end
+end

metadata

@@ -0,0 +1,143 @@
+--- !ruby/object:Gem::Specification
+name: kiik
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Julien Lucca
+- Esdras Eduardo
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-10-30 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: mocha
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.13'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.13'
+- !ruby/object:Gem::Dependency
+  name: shoulda
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.5'
+- !ruby/object:Gem::Dependency
+  name: test-unit
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.4'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.21.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.21.0
+description: KiiK's official gem that helps you to integrate with our services. See
+  https://docs.kiik.com.br for details.
+email:
+- lucca@kiik.com
+- esdras.rosa@kiik.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- README.md
+- Rakefile
+- config/kiik.yml
+- kiik.gemspec
+- lib/kiik.rb
+- lib/kiik/card.rb
+- lib/kiik/charge.rb
+- lib/kiik/customer.rb
+- lib/kiik/error.rb
+- lib/kiik/resource.rb
+- lib/kiik/rest/create.rb
+- lib/kiik/rest/update.rb
+- lib/kiik/util.rb
+- lib/tasks/kiik.rake
+- test/kiik/card_test.rb
+- test/kiik/charge_test.rb
+- test/kiik/customer_test.rb
+- test/test_helper.rb
+- test/test_mock.rb
+homepage: http://docs.kiik.com
+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.4.8
+signing_key: 
+specification_version: 4
+summary: Integrate Kiik with your Ruby app
+test_files:
+- test/kiik/card_test.rb
+- test/kiik/charge_test.rb
+- test/kiik/customer_test.rb
+- test/test_helper.rb
+- test/test_mock.rb