pickpoint_api 0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 08af998b998f4ca9f2902135d967b5df4b5a31fe
+  data.tar.gz: 484a27051f28e58a5a6fb4a93bd8d6dd6fd1d0e1
+SHA512:
+  metadata.gz: b18c637a31a3741b4d3de4da5c907917a343e3faa2effb070938f066b31148fc0910d0495c0ebdc1483112e53e4b42fb89a81e0794af4ca64e925cc8b7a9d774
+  data.tar.gz: 53c386ad19ca66bc492a5127c8c55b746d1a338254686c0b60e2fcd6812dc93a7b768f9432dd5dfd491c60c446b496b0c4c715128e9585a57851a07df9932d0c

data/.travis.yml

@@ -0,0 +1,7 @@
+language: ruby
+rvm:
+  - 2.1.0
+  - 1.9.3
+install: gem install rspec
+script: "rspec spec/*"
+

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2014 Kinderly LTD
+
+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,37 @@
+# Pickpoint API
+
+[![Build Status](https://travis-ci.org/kinderly/pickpoint_api.png?branch=master)](https://travis-ci.org/kinderly/pickpoint_api)
+
+## Description
+
+This gem provides a basic Ruby wrapper over [Pickpoint](http://pickpoint.ru/) API.
+
+## Usage
+
+```ruby
+require('pickpoint_api')
+
+PickpointApi.session('login', 'password', test: true) do |s|
+  postamats = s.postamat_list
+
+  s.create_sending(@my_sending_hash)
+
+  tracking_response = s.track_sending(@invoice_id_1)
+
+  labels_response_pdf = s.make_label([@invoice_id_1, @invoice_id_2])
+
+  reestr_response_pdf = s.make_reestr([@invoice_id_1, @invoice_id_2])
+
+end
+```
+
+Alternatively, you can create a Session object explicitly:
+
+```ruby
+require ('pickpoint_api')
+
+session = PickpointApi::Session.new(test: true)
+session.login('login', 'password')
+tracking_response = session.track_sending(@invoice_id_1)
+session.logout
+```

data/lib/pickpoint_api/constants.rb

@@ -0,0 +1,135 @@
+module PickpointApi::Constants
+  API_HOST = 'e-solution.pickpoint.ru'
+  API_PORT = 80
+  API_TEST_PATH = '/apitest'
+  API_PROD_PATH = '/api'
+
+  ACTIONS = {
+    login:
+    {
+      path: '/login',
+      method: :post
+    },
+    logout:
+    {
+      path: '/logout',
+      method: :post
+    },
+    create_sending:
+    {
+      path: '/createsending',
+      method: :post
+    },
+    create_shipment:
+    {
+      path: '/createshipment',
+      method: :post
+    },
+    make_return:
+    {
+      path: '/makereturn',
+      method: :post
+    },
+    get_return_invoice_list:
+    {
+      path: '/getreturninvoiceslist',
+      method: :post
+    },
+    track_sending:
+    {
+      path: '/tracksending',
+      method: :post
+    },
+    sending_info:
+    {
+      path: '/sendinginfo',
+      method: :post
+    },
+    get_delivery_cost:
+    {
+      path: '/getdeliverycost',
+      method: :post
+    },
+    courier:
+    {
+      path: '/courier',
+      method: :post
+    },
+    courier_cancel:
+    {
+      path: '/couriercancel',
+      method: :post
+    },
+    make_reestr:
+    {
+      path: '/makereestr',
+      method: :post
+    },
+    make_reestr_number:
+    {
+      path: '/makereestrnumber',
+      method: :post
+    },
+    get_reestr:
+    {
+      path: '/getreestr',
+      method: :post
+    },
+    make_label:
+    {
+      path: '/makelabel',
+      method: :post
+    },
+    make_zlabel:
+    {
+      path: '/makeZlabel',
+      method: :post
+    },
+    city_list:
+    {
+      path: '/citylist',
+      method: :get
+    },
+    postamat_list:
+    {
+      path: '/postamatlist',
+      method: :get
+    },
+    get_zone:
+    {
+      path: '/getzone',
+      method: :post
+    },
+    get_money_return_order:
+    {
+      path: '/getmoneyreturnorder',
+      method: :post
+    },
+    get_product_return_order:
+    {
+      path: '/getproductreturnorder',
+      method: :post
+    },
+    enclose_info:
+    {
+      path: '/encloseinfo',
+      method: :post
+    },
+    track_sendings:
+    {
+      path: '/tracksendings',
+      method: :post
+    },
+    get_states:
+    {
+      path: '/getstates',
+      method: :get
+    },
+    get_invoices_change_state:
+    {
+      path: '/getInvoicesChangeState',
+      method: :post
+    }
+  }.freeze
+
+end

data/lib/pickpoint_api/exceptions.rb

@@ -0,0 +1,5 @@
+module PickpointApi::Exceptions
+
+  ApiError = Class.new(StandardError)
+
+end

data/lib/pickpoint_api/session.rb

@@ -0,0 +1,179 @@
+require('net/http')
+require('json')
+
+class PickpointApi::Session
+  attr_reader :state
+  attr_reader :test
+
+  def initialize(hash = {})
+    @state = :new
+    @test = hash[:test] == true
+  end
+
+  def login(login, password)
+    if @state!= :new
+      return nil
+    end
+
+    data = {'Login' => login, 'Password' => password}
+    response = execute_action(:login, data)
+    response = JSON.parse(response)
+
+    if response['ErrorMessage'].nil? && !response['SessionId'].nil?
+      @session_id = response['SessionId']
+      @state = :started
+    else
+      @state = :error
+      raise ::PickpointApi::Exceptions::ApiError, response['ErrorMessage']
+    end
+  end
+
+  def logout
+    if !@session_id.nil? && @state == :started
+      data = {'SessionId' => @session_id}
+      response = execute_action :logout, data
+      response = JSON.parse(response)
+      if response['Success']
+        @state = :closed
+        @session_id = nil
+        return true
+      else
+        return false
+      end
+    else
+      return false
+    end
+  end
+
+  def create_sending(data)
+    if @state == :started
+      data = attach_session_id(data, 'Sendings')
+      response = execute_action(:create_sending, data)
+      response = JSON.parse(response)
+    end
+  end
+
+  def track_sending(invoice_id)
+    if @state != :started
+      return nil
+    end
+
+    data = invoice_id
+    data = attach_session_id(data, 'InvoiceNumber')
+    response = execute_action(:track_sending, data)
+
+    if response.nil? || response.empty?
+      return nil
+    end
+
+    response = JSON.parse(response)
+  end
+
+  def postamat_list
+    if @state == :started
+      response = execute_action(:postamat_list)
+      response = JSON.parse(response)
+    end
+  end
+
+  def make_label(invoice_id)
+    if @state != :started
+      return nil
+    end
+
+    if invoice_id.kind_of?(Array)
+      data = invoice_id
+    elsif
+      data = [invoice_id]
+    end
+
+    data = attach_session_id(data,'Invoices')
+    response = execute_action(:make_label, data)
+
+    if response.start_with?("Error")
+      raise ::PickpointApi::Exceptions::ApiError, response
+      return nil
+    else
+      return response
+    end
+  end
+
+  def make_reestr(invoice_id)
+    if @state != :started
+      return nil
+    end
+
+    if invoice_id.kind_of?(Array)
+      data = invoice_id
+    elsif
+      data = [invoice_id]
+    end
+
+    data = attach_session_id(data,'Invoices')
+    response = execute_action(:make_reestr, data)
+
+    if response.start_with?("Error")
+      raise ::PickpointApi::Exceptions::ApiError, response
+      return nil
+    else
+      return response
+    end
+  end
+
+  private
+
+  def api_path
+    if @test
+      ::PickpointApi::Constants::API_TEST_PATH
+    else
+      ::PickpointApi::Constants::API_PROD_PATH
+    end
+  end
+
+  def create_request(action)
+    action_config = ::PickpointApi::Constants::ACTIONS[action]
+    if action_config.nil?
+      return nil
+    end
+
+    action_path = "#{api_path}#{action_config[:path]}"
+
+    if action_config[:method] == :post
+      req = ::Net::HTTP::Post.new action_path
+    elsif action_config[:method] == :get
+      req = ::Net::HTTP::Get.new action_path
+    end
+
+    req.content_type = 'application/json'
+
+    req
+  end
+
+  def attach_session_id(data, key)
+    {
+      'SessionId' => @session_id,
+      key => data
+    }
+  end
+
+  def execute_action(action, data = {})
+    req = create_request action
+
+    if req.nil?
+      return nil
+    end
+
+    req.body = data.to_json
+
+    response = send_request(req)
+
+    response.body
+  end
+
+  def send_request(req)
+    ::Net::HTTP.start(::PickpointApi::Constants::API_HOST, ::PickpointApi::Constants::API_PORT) do |http|
+      http.request(req)
+    end
+  end
+
+end

data/lib/pickpoint_api.rb

@@ -0,0 +1,21 @@
+module PickpointApi
+
+  def self.session login, password, hash = {}
+    begin
+      session = Session.new hash
+      session.login login, password
+      yield session
+    rescue => ex
+      raise ::PickpointApi::Exceptions::ApiError, ex.message
+    ensure
+      if !session.nil? && session.state != :closed
+        session.logout
+      end
+    end
+  end
+
+end
+
+require_relative('pickpoint_api/constants.rb')
+require_relative('pickpoint_api/session.rb')
+require_relative('pickpoint_api/exceptions.rb')

data/pickpoint_api.gemspec

@@ -0,0 +1,15 @@
+Gem::Specification.new do |s|
+  s.name = "pickpoint_api"
+  s.version = "0.1"
+  s.authors = ["Kinderly LTD"]
+  s.email = ["nuinuhin@gmail.com"]
+  s.homepage = "http://github.com/kinderly/pickpoint_api"
+
+  s.summary = %q{A wrapper for Pickpoint API}
+  s.description = %q{This gem provides a Ruby wrapper over Pickpoint API.}
+  s.license = "MIT"
+
+  s.files = `git ls-files`.split("\n")
+  s.test_files = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.require_paths = ["lib"]
+end

data/spec/pickpoint_api.rb

@@ -0,0 +1,15 @@
+require_relative '../lib/pickpoint_api.rb'
+require_relative './support/dummy_data.rb'
+require_relative './support/http_mocking.rb'
+
+include DummyData
+
+describe 'PickpointApi' do
+  it 'should run session' do
+    HttpMocking.set_next_response(LOGIN_SUCCESSFULL)
+
+    PickpointApi.session('login', 'password', test:true) do |s|
+      HttpMocking.set_next_response(LOGOUT_SUCCESSFULL)
+    end
+  end
+end

data/spec/session.rb

@@ -0,0 +1,111 @@
+# coding: utf-8
+
+require_relative '../lib/pickpoint_api.rb'
+require_relative './support/dummy_data.rb'
+require_relative './support/http_mocking.rb'
+
+include DummyData
+
+describe ::PickpointApi::Session do
+  before(:each) do
+    @session = ::PickpointApi::Session.new(test: true)
+
+    ::HttpMocking.set_next_response(LOGIN_SUCCESSFULL)
+  end
+
+  it 'can instatiate' do
+    expect(@session).not_to be_nil
+    expect(@session.test).to eq true
+    expect(@session.state).to eq :new
+  end
+
+  describe '.login' do
+    it 'should log-in' do
+      @session.login('login', 'password')
+      expect(@session.state).to eq :started
+    end
+
+    it 'should handle incorrect login' do
+      ::HttpMocking.set_next_response(LOGIN_FAILED)
+      expect { @session.login('login', 'password') }.to raise_error ::PickpointApi::Exceptions::ApiError
+      expect(@session.state).to eq(:error)
+    end
+  end
+
+  describe '.logout' do
+    it 'should log out' do
+      @session.login('login', 'password')
+      ::HttpMocking.set_next_response(LOGOUT_SUCCESSFULL)
+      expect(@session.logout).to eq(true)
+      expect(@session.state).to eq(:closed)
+    end
+  end
+
+  describe '.create_sending' do
+    it 'should handle succesfull request' do
+      @session.login('login', 'password')
+      ::HttpMocking.set_next_response(CREATE_SENDING_SUCCESSFULL)
+      res = @session.create_sending(SAMPLE_SENDING_REQUEST)
+      expect(res['CreatedSendings']).not_to be_empty
+      expect(res['RejectedSendings']).to be_empty
+    end
+  end
+
+  describe '.track_sending' do
+    it 'should handle succesfull request' do
+      @session.login('login', 'password')
+      ::HttpMocking.set_next_response({}.to_json)
+      res = @session.track_sending('21121312')
+    end
+  end
+
+  describe '.postamat_list' do
+    it 'should handle succesfull request' do
+      @session.login('login', 'password')
+      ::HttpMocking.set_next_response({}.to_json)
+      @session.postamat_list
+    end
+  end
+
+  describe '.make_label' do
+    it 'should handle succesfull request' do
+      @session.login('login', 'password')
+      ::HttpMocking.set_next_response('%PDF')
+      @session.make_label('12345')
+    end
+
+    it 'should handle multiple invoices' do
+      @session.login('login', 'password')
+      ::HttpMocking.set_next_response('%PDF')
+      @session.make_label(['123123','123213'])
+    end
+
+    it 'should handle api error' do
+      @session.login('login', 'password')
+      ::HttpMocking.set_next_response('Error: Случилось что-то ужасное')
+      expect{@session.make_label(['123123'])}.to raise_error PickpointApi::Exceptions::ApiError
+    end
+  end
+
+  describe '.make_reestr' do
+    it 'should handle succesfull request' do
+      @session.login('login', 'password')
+      ::HttpMocking.set_next_response('%PDF')
+      @session.make_reestr('12345')
+    end
+
+    it 'should handle multiple invoices' do
+      @session.login('login', 'password')
+      ::HttpMocking.set_next_response('%PDF')
+      @session.make_reestr(['123123','123213'])
+
+    end
+
+    it 'should handle api error' do
+      @session.login('login', 'password')
+      ::HttpMocking.set_next_response('Error: Случилось что-то ужасное')
+      expect{@session.make_reestr(['123123'])}.to raise_error PickpointApi::Exceptions::ApiError
+    end
+  end
+
+end

data/spec/support/dummy_data.rb

@@ -0,0 +1,45 @@
+# coding: utf-8
+
+require ('json')
+
+module DummyData
+  LOGIN_SUCCESSFULL = {'SessionId' => '111111111'}.to_json
+  LOGIN_FAILED = {'ErrorMessage' => 'Неверный логин или пароль'}.to_json
+  LOGOUT_SUCCESSFULL = {'Success' => true}.to_json
+  CREATE_SENDING_SUCCESSFULL = {
+    "CreatedSendings" => [
+      {
+        'EDTN' => "14",
+        'IKN' => "9990000000",
+        'Barcode' => '200819647155'
+      }
+    ],
+    "RejectedSendings" => []
+  }.to_json
+
+  SAMPLE_SENDING_REQUEST =  {
+    "EDTN" => 14,
+    "IKN" => "9990000000",
+     "Invoice" => {
+        "SenderCode" => 2121,
+        "Description" => "A description",
+        "RecipientName" => "John Doe",
+        "PostamatNumber" => "6101-004",
+        "MobilePhone" => "+79030000000",
+        "Email" => nil,
+        "PostageType" => "10003",
+        "GettingType" => "101",
+        "PayType" => "1",
+        "Sum" => 4490.0,
+        "SubEncloses" => [
+          {
+            "Line" => 1,
+            "ProductCode" => 4559802,
+            "GoodsCode" => "79380-555",
+            "Name" => "Fire extinguisher large",
+            "Price" => 4290.0
+          }]
+      }
+  }
+
+end

data/spec/support/http_mocking.rb

@@ -0,0 +1,14 @@
+require 'net/http'
+
+
+module HttpMocking
+
+  def self.set_next_response(response_body, code = 200, msg='OK')
+    Net::HTTP.any_instance.stub(:request) do |req|
+      response = Net::HTTPResponse.new(1.0, code, msg)
+      response.stub(:body => response_body)
+      response
+    end
+  end
+
+end

metadata

@@ -0,0 +1,57 @@
+--- !ruby/object:Gem::Specification
+name: pickpoint_api
+version: !ruby/object:Gem::Version
+  version: '0.1'
+platform: ruby
+authors:
+- Kinderly LTD
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-03-03 00:00:00.000000000 Z
+dependencies: []
+description: This gem provides a Ruby wrapper over Pickpoint API.
+email:
+- nuinuhin@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- LICENSE
+- README.md
+- lib/pickpoint_api.rb
+- lib/pickpoint_api/constants.rb
+- lib/pickpoint_api/exceptions.rb
+- lib/pickpoint_api/session.rb
+- pickpoint_api.gemspec
+- spec/pickpoint_api.rb
+- spec/session.rb
+- spec/support/dummy_data.rb
+- spec/support/http_mocking.rb
+homepage: http://github.com/kinderly/pickpoint_api
+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.2.2
+signing_key: 
+specification_version: 4
+summary: A wrapper for Pickpoint API
+test_files: []