checkout_ru 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 4f7c669476b48bf6c2585075af8cf275904df085
+  data.tar.gz: 901fa3aaa1776114ae22bbf858643ee11e952002
+SHA512:
+  metadata.gz: fa118d735dc00134517804754068b6f0eafbc26ba73cb07327d6219e69c3243fd315f21f5da068538ab617336848c739adc19d946fd22412cbc1390954217828
+  data.tar.gz: 7efcb3ac91d2159a020ef60ca72657c2541f46f959addd1f3c1a70072cb7580509e754d45f3d2d9827b6fed24e70695140ed04ca91bafe598e2011079d81bc88

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in checkout_ru.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Maxim Chernyak
+
+MIT License
+
+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,72 @@
+# CheckoutRu
+
+Thin ruby client for checkout.ru integration.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'checkout_ru'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install checkout_ru
+
+## Usage
+
+```ruby
+CheckoutRu.api_key = 'my-api-key'
+
+session = CheckoutRu::Session.initiate
+places = session.get_places_by_query('Москва')
+places[0].name # => "г. Москва"
+
+order = CheckoutRu::Order.new(
+  goods: [
+    CheckoutRu::Item.new(
+      name:          'blue tshirt',
+      code:          'blt',
+      variant_code:  'blue',
+      quantity:      2,
+      assessed_cost: 1000,
+      pay_cost:      750,
+      weight:        0.5
+    )
+  ],
+
+  delivery: CheckoutRu::Delivery.new(
+    delivery_id:   2,
+    place_fias_id: '0c5b2444-70a0-4932-980c-b4dc0d3f02b5',
+    address_pvz:   'Энтузиастов ш.,  д. 54',
+    type:          'postamat',
+    cost:          224.41,
+    min_term:      2,
+    max_term:      11
+  ),
+
+  user: CheckoutRu::User.new(
+    fullname: 'Вася Пупкин',
+    email:    'vasyapupkin@example.com',
+    phone:    '555'
+  ),
+
+  comment:        'test order',
+  shop_order_id:  '777',
+  payment_method: 'cash'
+)
+
+CheckoutRu.create_order(order) # => <Hashie::Mash>, structure:
+# {"order":{"id":75},"delivery":{"id":2,"service_name":"PickPoint"}}
+```
+
+## Contributing
+
+1. Fork it ( http://github.com/maxim/checkout_ru/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,9 @@
+require 'bundler/gem_tasks'
+require 'rake/testtask'
+
+Rake::TestTask.new do |t|
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+end
+
+task :default => :test

data/checkout_ru.gemspec

@@ -0,0 +1,32 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'checkout_ru/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "checkout_ru"
+  spec.version       = CheckoutRu::VERSION
+  spec.authors       = ["Maxim Chernyak"]
+  spec.email         = ["max@bitsonnet.com"]
+  spec.summary       = %q{Ruby client for checkout.ru}
+  spec.description   = %q{Ruby client for checkout.ru.}
+  spec.homepage      = 'http://github.com/maxim/checkout_ru'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_runtime_dependency 'faraday', '~> 0.8'
+  spec.add_runtime_dependency 'faraday_middleware', '~> 0.9'
+  spec.add_runtime_dependency 'faraday_middleware-multi_json', '~> 0.0'
+  spec.add_runtime_dependency 'multi_json', '~> 1.8'
+  spec.add_runtime_dependency 'hashie', '~> 2.0'
+  spec.add_runtime_dependency 'nokogiri', '~> 1.6'
+
+  spec.add_development_dependency 'bundler', '~> 1.5'
+  spec.add_development_dependency 'rake', '~> 10'
+  spec.add_development_dependency 'minitest', '~> 5.2'
+  spec.add_development_dependency 'vcr', '~> 2.8'
+end

data/lib/checkout_ru/address.rb

@@ -0,0 +1,12 @@
+require 'checkout_ru/entity'
+
+module CheckoutRu
+  class Address < Entity
+    property :postindex
+    property :street_fias_id, :from => :streetFiasId
+    property :house
+    property :housing
+    property :building
+    property :appartment # [sic]
+  end
+end

data/lib/checkout_ru/delivery.rb

@@ -0,0 +1,19 @@
+require 'checkout_ru/entity'
+require 'checkout_ru/address'
+
+module CheckoutRu
+  class Delivery < Entity
+    property :delivery_id,     :required => true, :from => :deliveryId
+    property :place_fias_id,   :required => true, :from => :placeFiasId
+
+    property :address_express, :from => :addressExpress
+    property :address_pvz,     :from => :addressPvz
+
+    property :type,     :required => true
+    property :cost,     :required => true
+    property :min_term, :required => true, :from => :minTerm
+    property :max_term, :required => true, :from => :maxTerm
+
+    coerce_key :address_express, Address
+  end
+end

data/lib/checkout_ru/entity.rb

@@ -0,0 +1,14 @@
+require 'hashie'
+require 'multi_json'
+
+module CheckoutRu
+  class Entity < Hashie::Trash
+    include Hashie::Extensions::Coercion
+
+    def to_json(options = {})
+      hash = self.to_hash
+      CheckoutRu.camelize_keys!(hash)
+      MultiJson.dump(hash, options.merge(:pretty => true))
+    end
+  end
+end

data/lib/checkout_ru/item.rb

@@ -0,0 +1,21 @@
+require 'checkout_ru/entity'
+
+module CheckoutRu
+  class Item < Entity
+    class << self
+      def coerce(value)
+        value.is_a?(Array) ?
+          value.map{ |hash| new(hash) } :
+          new(value)
+      end
+    end
+
+    property :name,          :required => true
+    property :code,          :required => true
+    property :variant_code,  :required => true, :from => :variantCode
+    property :quantity,      :required => true
+    property :assessed_cost, :required => true, :from => :assessedCost
+    property :pay_cost,      :required => true, :from => :payCost
+    property :weight,        :required => true
+  end
+end

data/lib/checkout_ru/order.rb

@@ -0,0 +1,34 @@
+require 'checkout_ru/entity'
+require 'checkout_ru/item'
+require 'checkout_ru/delivery'
+require 'checkout_ru/user'
+
+module CheckoutRu
+  class Order < Entity
+    module Status
+      CREATED = 'CREATED'.freeze
+      CANCELLED_BEFORE_SHIPMENT = 'CANCELLED_BEFORE_SHIPMENT'.freeze
+
+      MAP = {
+        :created => CREATED,
+        :cancelled_before_shipment => CANCELLED_BEFORE_SHIPMENT
+      }.freeze
+    end
+
+    property :goods
+    property :delivery, :required => true
+    property :user, :required => true
+    property :comment
+    property :shop_order_id, :from => :shopOrderId
+    property :payment_method, :required => true, :from => :paymentMethod
+
+    coerce_key :goods, Item
+    coerce_key :delivery, Delivery
+    coerce_key :user, User
+
+    def initialize(*)
+      super
+      self[:goods] ||= []
+    end
+  end
+end

data/lib/checkout_ru/session.rb

@@ -0,0 +1,46 @@
+module CheckoutRu
+  class Session
+    class << self
+      def initiate
+        ticket = CheckoutRu.get_ticket
+        new(ticket)
+      end
+    end
+
+    def initialize(ticket, options = {})
+      @ticket = ticket
+      @conn = CheckoutRu.build_connection
+    end
+
+    def get_places_by_query(options = {})
+      get('checkout/getPlacesByQuery', options).suggestions
+    end
+
+    def calculation(options = {})
+      params = options.dup
+      get('checkout/calculation', params)
+    end
+
+    def get_streets_by_query(options = {})
+      params = options.dup
+      get('checkout/getStreetsByQuery', params).suggestions
+    end
+
+    def get_postal_code_by_address(options = {})
+      params = options.dup
+      get('checkout/getPostalCodeByAddress', params).postindex
+    end
+
+    def get_place_by_postal_code(options = {})
+      get('checkout/getPlaceByPostalCode', options)
+    end
+
+    private
+    def get(service, params = {})
+      CheckoutRu.make_request \
+        "/service/#{service}",
+        :connection => @conn,
+        :params => params.merge(:ticket => @ticket)
+    end
+  end
+end

data/lib/checkout_ru/user.rb

@@ -0,0 +1,9 @@
+require 'checkout_ru/entity'
+
+module CheckoutRu
+  class User < Entity
+    property :fullname
+    property :email
+    property :phone
+  end
+end

data/lib/checkout_ru/version.rb

@@ -0,0 +1,3 @@
+module CheckoutRu
+  VERSION = "0.0.1"
+end

data/lib/checkout_ru.rb

@@ -0,0 +1,147 @@
+require 'date'
+require 'time'
+require 'faraday'
+require 'faraday_middleware'
+require 'faraday_middleware-multi_json'
+require 'nokogiri'
+
+require 'checkout_ru/version'
+require 'checkout_ru/session'
+require 'checkout_ru/order'
+
+module CheckoutRu
+  SERVICE_URL = 'http://platform.checkout.ru'.freeze
+
+  Error = Class.new(Faraday::Error::ClientError)
+
+  class << self
+    attr_accessor :api_key, :adapter
+
+    def get_ticket(options = {})
+      api_key = options[:api_key] || api_key
+      make_request("/service/login/ticket/#{api_key}")['ticket']
+    end
+
+    def create_order(order, options = {})
+      api_key = options[:api_key] || api_key
+      make_request '/service/order/create',
+        :via    => :post,
+        :mash   => true,
+        :params => { :api_key => api_key, :order => order }
+    end
+
+    def update_order(remote_id, order, options = {})
+      api_key = options[:api_key] || api_key
+      make_request "/service/order/#{remote_id}",
+        :via => :post,
+        :mash => true,
+        :params => { :api_key => api_key, :order => order }
+    end
+
+    def status(remote_id, status, options = {})
+      api_key = options[:api_key] || api_key
+      status_map = Order::Status::MAP
+
+      status_string = if status.is_a?(Symbol)
+        unless status_map.keys.include?(status)
+          raise Error, "Invalid order status: #{status}"
+        end
+
+        status_map[status]
+      else
+        unless status_map.values.include?(status)
+          raise Error, "Invalid order status: #{status}"
+        end
+
+        status
+      end
+
+      make_request "/service/order/status/#{remote_id}",
+        :via => :post,
+        :params => { :api_key => api_key, :status => status_string }
+    end
+
+    def status_history(order_id, options = {})
+      api_key = options[:api_key] || api_key
+      response = make_request "/service/order/statushistory/#{order_id}",
+        :params => { :api_key => api_key }
+
+      response.order.date = Date.parse(response.order.date)
+      response
+    end
+
+    def build_connection(options = {})
+      Faraday.new(:url => options[:url] || SERVICE_URL) do |faraday|
+        faraday.request :multi_json
+        faraday.response :raise_error
+        faraday.response :multi_json
+        faraday.adapter options[:adapter] || adapter || Faraday.default_adapter
+      end
+    end
+
+    def make_request(service, options = {})
+      conn   = options[:connection] || build_connection
+      method = options[:via]        || :get
+      params = options[:params].dup if options[:params]
+      camelize_keys!(params)
+
+      body = conn.public_send(method, service, params,
+        { 'Accept' => 'application/json' }
+      ).body
+
+      underscore_keys!(body)
+
+      case body
+      when Hash
+        ::Hashie::Mash.new(body)
+      when Array
+        body.map{|el| ::Hashie::Mash.new(el)}
+      else
+        body
+      end
+
+    rescue Faraday::Error::ClientError => e
+      begin
+        doc = Nokogiri::HTML(e.response[:body])
+        doc.css('script, link').each(&:remove)
+        msg = doc.css('body h1').text
+      rescue
+        raise e
+      else
+        raise Error, msg
+      end
+    end
+
+    def camelize_keys!(obj)
+      case obj
+      when Hash
+        obj.replace(Hash[
+          obj.map do |key, value|
+            [ key.to_s.downcase.gsub(/_([a-z\d]*)/) { "#{$1.capitalize}" },
+              camelize_keys!(value) ]
+          end
+        ])
+      when Array
+        obj.map! {|el| camelize_keys!(el)}
+      else
+        obj
+      end
+    end
+
+    def underscore_keys!(obj)
+      case obj
+      when Hash
+        obj.replace(Hash[
+          obj.map do |key, value|
+            [ key.to_s.gsub(/([a-z\d])([A-Z])/, '\1_\2').downcase,
+              underscore_keys!(value) ]
+          end
+        ])
+      when Array
+        obj.map! {|el| underscore_keys!(el)}
+      else
+        obj
+      end
+    end
+  end
+end

data/test/checkout_ru/session_test.rb

@@ -0,0 +1,82 @@
+require 'test_helper'
+
+class CheckoutRu::SessionTest < MiniTest::Test
+  def setup
+    @session = CheckoutRu::Session.new('valid-ticket')
+  end
+
+  def test_get_places_by_query
+    VCR.use_cassette('get_places_by_query') do
+      places = @session.get_places_by_query(:place => 'москва')
+
+      assert_equal 4, places.size
+
+      assert_equal '0c5b2444-70a0-4932-980c-b4dc0d3f02b5', places[0].id
+      assert_equal 'Москва', places[0].name
+      assert_equal 'г. Москва', places[0].full_name
+
+      assert_equal '3605e660-e90e-47d3-b58e-068f24e68145', places[1].id
+      assert_equal 'Москва', places[1].name
+      assert_equal 'д. Москва (Пеновский район, Тверская область)',
+        places[1].full_name
+    end
+  end
+
+  def test_calculation
+    VCR.use_cassette('calculation') do
+      calculation = @session.calculation(
+        :place_id     => '0c5b2444-70a0-4932-980c-b4dc0d3f02b5',
+        :total_sum    => 1500,
+        :assessed_sum => 2000,
+        :items_count  => 2,
+        :total_weight => 1
+      )
+
+      assert calculation.keys.include?('postamat')
+      assert calculation.keys.include?('pvz')
+      assert calculation.keys.include?('express')
+
+      assert_equal 73, calculation.postamat.costs.size
+      assert_equal 68, calculation.pvz.costs.size
+      assert_equal 340, calculation.express.cost
+    end
+  end
+
+  def test_get_streets_by_query
+    VCR.use_cassette('get_streets_by_query') do
+      streets = @session.get_streets_by_query(
+        :street => 'мас',
+        :place_id => '0c5b2444-70a0-4932-980c-b4dc0d3f02b5'
+      )
+
+      assert_equal '960972e8-48bb-4837-b0ee-ee0347931b73', streets[0].id
+      assert_equal 'Масловка Верхн.', streets[0].name
+      assert_equal 'ул', streets[0].type
+
+      assert_equal 'ad4b99f0-33da-4661-aa29-057557cf4147', streets[1].id
+      assert_equal 'Масловка Нижн.', streets[1].name
+      assert_equal 'ул', streets[1].type
+    end
+  end
+
+  def test_get_postal_code_by_address
+    VCR.use_cassette('get_postal_code_by_address') do
+      postal_code = @session.get_postal_code_by_address(
+        :street_id => '2b453e3c-d908-4608-b81c-a314a687bee3',
+        :house => 13, :housing => '', :building => ''
+      )
+
+      assert_equal '111524', postal_code
+    end
+  end
+
+  def test_get_place_by_postal_code
+    VCR.use_cassette('get_place_by_postal_code') do
+      place = @session.get_place_by_postal_code(:post_index => '111524')
+
+      assert_equal '0c5b2444-70a0-4932-980c-b4dc0d3f02b5', place.id
+      assert_equal 'Москва', place.name
+      assert_equal 'г. Москва', place.full_name
+    end
+  end
+end