pickpoint_api 0.1 → 0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 08af998b998f4ca9f2902135d967b5df4b5a31fe
-  data.tar.gz: 484a27051f28e58a5a6fb4a93bd8d6dd6fd1d0e1
+  metadata.gz: ef1e97123ee49d134743d512ee9c86286ca1dafe
+  data.tar.gz: b4d7fe95f57f1cc33b08d6db78f68644d4d2761a
 SHA512:
-  metadata.gz: b18c637a31a3741b4d3de4da5c907917a343e3faa2effb070938f066b31148fc0910d0495c0ebdc1483112e53e4b42fb89a81e0794af4ca64e925cc8b7a9d774
-  data.tar.gz: 53c386ad19ca66bc492a5127c8c55b746d1a338254686c0b60e2fcd6812dc93a7b768f9432dd5dfd491c60c446b496b0c4c715128e9585a57851a07df9932d0c
+  metadata.gz: a58f2dc4bc46cfdb60baa7bd890da307cbca44625fa8c24ecab7e40a92d3f1aac9855bd1ace825cc2c821d1f0fd429013b6a63cb238941e4bcb5d2226a5be48e
+  data.tar.gz: 57f86a3c6d8e48d048f986c13d7581b84fb564f814fbfca79680e2088fcffb578b260fd8f5fd9acc4e7e09f145564352f1d335e6853b52886886454acadbe369

data/.gitignore

@@ -0,0 +1 @@
+/coverage

data/.rspec

@@ -0,0 +1,2 @@
+--default-path spec
+--color

data/.travis.yml

@@ -2,6 +2,6 @@ language: ruby
 rvm:
   - 2.1.0
   - 1.9.3
-install: gem install rspec
-script: "rspec spec/*"
+install: gem install rspec coveralls
+script: "rspec"
 

data/README.md

@@ -1,27 +1,72 @@
 # Pickpoint API
 
 [![Build Status](https://travis-ci.org/kinderly/pickpoint_api.png?branch=master)](https://travis-ci.org/kinderly/pickpoint_api)
+[![Gem Version](https://badge.fury.io/rb/pickpoint_api.png)](http://badge.fury.io/rb/pickpoint_api)
+[![Coverage Status](https://coveralls.io/repos/kinderly/pickpoint_api/badge.png)](https://coveralls.io/r/kinderly/pickpoint_api)
+[![Code Climate](https://codeclimate.com/github/kinderly/pickpoint_api.png)](https://codeclimate.com/github/kinderly/pickpoint_api)
 
 ## Description
 
-This gem provides a basic Ruby wrapper over [Pickpoint](http://pickpoint.ru/) API.
+This gem provides a Ruby wrapper over [Pickpoint](http://pickpoint.ru/) API. All API methods documented by Feb 1 2014 are implemented.
 
-## Usage
+## Installation
 
-```ruby
-require('pickpoint_api')
+You can install this gem with the following command:
 
-PickpointApi.session('login', 'password', test: true) do |s|
-  postamats = s.postamat_list
+```bash
+gem install pickpoint_api
+```
 
-  s.create_sending(@my_sending_hash)
+Or, if you are using Bundler, add it to your Gemfile:
 
-  tracking_response = s.track_sending(@invoice_id_1)
+```ruby
+gem pickpoint_api
+```
 
-  labels_response_pdf = s.make_label([@invoice_id_1, @invoice_id_2])
+If you desire to have the most up-do-date development version, add Git URL to the Gemfile:
+```ruby
+gem pickpoint_api, git: 'git@github.com:kinderly/pickpoint_api.git'
+```
+
+## Usage
 
-  reestr_response_pdf = s.make_reestr([@invoice_id_1, @invoice_id_2])
+```ruby
+require('pickpoint_api')
 
+PickpointApi.session('login', 'password', test: true) do |s|
+  result = s.create_sending(@my_sending_hash)
+  result = s.create_shipment(@my_shipment_hash)
+  result = s.make_return(invoice_id: @invoice_id)
+  result = s.make_return(sender_invoice_number: @order_number)
+  return_invoices_list = s.get_return_invoices_list(DateTime.parse('2014-01-01'), DateTime.now)
+  tracking_response = s.track_sending(@invoice_id)
+  tracking_response = s.track_sending(nil, @order_number)
+  info = s.sending_info(@invoice_id)
+  info = s.sending_info(nil, @order_number)
+  cost_result = s.get_delivery_cost(@delivery_hash)
+  courier_result = s.courier(@courier_hash)
+  courier_cancel_result = s.courier_cancel(@courier_order_number)
+  reestr_response_pdf = s.make_reestr(@invoice_id)
+  reestr_response_pdf = s.make_reestr([@invoice_id1, @invoice_id2])
+  reestr_numbers = s.make_reestr_number(@invoice_id)
+  reestr_numbers = s.make_reestr_number([@invoice_id1, @invoice_id2])
+  reestr_pdf = get_reestr(@invoice_id)
+  reestr_pdf = get_reestr(nil, @reestr_number)
+  labels_pdf = make_label(invoice_id)
+  labels_pdf = make_label([@invoice_id1, @invoice_id2])
+  zebra_labels_pdf = make_zlabel(invoice_id)
+  zebra_labels_pdf = make_zlabel([@invoice_id1, @invoice_id2])
+  cities = s.city_list
+  postamats = s.postamat_list
+  zone_info = s.get_zone(@city_name)
+  zone_info = s.get_zone(@city_name, @postamat_num)
+  result = s.get_money_return_order(@ikn, @document_number, @date_from, @date_to)
+  result = s.get_product_return_order(@ikn, @document_number, @date_from, @date_to)
+  result = s.enclose_info(@barcode)
+  history = s.track_sendings(invoice_id)
+  history = s.track_sendings([@invoice_id1, @invoice_id2])
+  states = s.get_states
+  registered_invoices = s.get_invoices_change_state(101, @date_from, @date_to)
 end
 ```
 
@@ -32,6 +77,10 @@ require ('pickpoint_api')
 
 session = PickpointApi::Session.new(test: true)
 session.login('login', 'password')
-tracking_response = session.track_sending(@invoice_id_1)
+cities = s.city_list
+postamats = s.postamat_list
+zone_info = s.get_zone(@city_name)
 session.logout
 ```
+
+Please refer to the official [Pickpoint](http://pickpoint.ru/) API documentation to learn about method meanings, expected request arguments, data format etc.

data/lib/pickpoint_api.rb

@@ -1,4 +1,18 @@
+require('logger')
+
 module PickpointApi
+  VERSION = "0.2"
+
+  @logger = Logger.new($stdout)
+  @logger.level = Logger::INFO
+
+  def self.logger=(logger)
+    @logger = logger
+  end
+
+  def self.logger
+    @logger
+  end
 
   def self.session login, password, hash = {}
     begin
@@ -8,7 +22,7 @@ module PickpointApi
     rescue => ex
       raise ::PickpointApi::Exceptions::ApiError, ex.message
     ensure
-      if !session.nil? && session.state != :closed
+      if !session.nil? && session.state == :started
         session.logout
       end
     end
@@ -16,6 +30,8 @@ module PickpointApi
 
 end
 
+require_relative('pickpoint_api/exceptions.rb')
 require_relative('pickpoint_api/constants.rb')
 require_relative('pickpoint_api/session.rb')
-require_relative('pickpoint_api/exceptions.rb')
+
+

data/lib/pickpoint_api/api_actions.rb

@@ -0,0 +1,252 @@
+require('net/http')
+require('json')
+require('date')
+
+module PickpointApi::ApiActions
+  include(::PickpointApi::Exceptions)
+  include(::PickpointApi::Constants)
+
+  # Начало сессии
+  def login(login, password)
+    ensure_session_state(:new)
+    data = {'Login' => login, 'Password' => password}
+    response = json_request(:login, data)
+    check_for_error(response, 'ErrorMessage', LoginError) do
+      @state = :error
+    end
+
+    @session_id = response['SessionId']
+    @state = :started
+    nil
+  end
+
+  # Завершение сессии
+  def logout
+    ensure_session_state
+    data = {'SessionId' => @session_id}
+    response = json_request(:logout, data)
+
+    if response['Success'] == true
+      @state = :closed
+      @session_id = nil
+    else
+      @state = :error
+      raise LogoutError
+    end
+  end
+
+  # Регистрация одноместных отправлений
+  def create_sending(data)
+    sendings_request(:create_sending, data)
+  end
+
+  # Регистрация многоместных отправлений
+  def create_shipment(data)
+    sendings_request(:create_shipment, data)
+  end
+
+  # Создание отправления клиентского возврата
+  def make_return(options)
+    ensure_session_state
+
+    if !options[:invoice_id].nil? && !options[:sender_invoice_number].nil?
+      raise ApiError 'Only :invoice_id or :sender_invoice_number parameter should be specified'
+    end
+
+    data = {
+      'SessionId' => @session_id
+    }
+
+    if !options[:invoice_id].nil?
+      data['InvoiceNumber'] = options[:invoice_id]
+    elsif !options[:sender_invoice_number].nil?
+      data['GCInvoiceNumber'] = options[:sender_invoice_number]
+    else
+      raise ApiError 'Either :invoice_id or :sender_invoice_number parameter should be specified'
+    end
+
+    response = json_request(:make_return, data)
+
+    errors = res.select do |x|
+      !x['Error'].nil? && !x['Error'].empty?
+    end.map do |x|
+      x['Error']
+    end
+
+    if !errors.empty
+      raise ApiError errors.join(';')
+    end
+
+    res
+  end
+
+  # Получение списка возвратных отправлений
+  def get_return_invoices_list(date_from, date_to = DateTime.now)
+    ensure_session_state
+    data = {
+      'SessionId' => @session_id,
+      'DateFrom' => date_from.strftime(DATE_FORMAT),
+      'DateTo' => date_to.strftime(DATE_FORMAT)
+    }
+    res = json_request(:get_return_invoice_list, data)
+    check_for_error(res, 'Error')
+  end
+
+  # Мониторинг отправления
+  def track_sending(invoice_id = nil, sender_invoice_number = nil)
+    request_by_invoice_id(:track_sending, invoice_id, sender_invoice_number)
+  end
+
+  # Получение информации по отправлению
+  def sending_info(invoice_id = nil, sender_invoice_number = nil)
+    request_by_invoice_id(:sending_info, invoice_id, sender_invoice_number)
+  end
+
+  # Получение стоимости доставки
+  def get_delivery_cost(options)
+    ensure_session_state
+
+    if !options[:invoice_ids].nil? && !options[:sender_invoice_numbers].nil?
+      raise ApiError 'Only :invoice_ids or :sender_invoice_numbers parameter should be specified'
+    end
+
+    data = if !options[:invoice_ids].nil?
+      options[:invoice_ids].map do |invoice_id|
+        {'InvoiceNumber' => invoice_id}
+      end
+    elsif !options[:sender_invoice_numbers].nil?
+      options[:invoice_ids].map do |invoice_id|
+        {'SenderInvoiceNumber' => invoice_id}
+      end
+    else
+      raise ApiError 'Either :invoice_ids or :sender_invoice_numbers parameter should be specified'
+    end
+
+    data = attach_session_id('Sendings', data)
+    json_request(:get_delivery_cost, data)
+  end
+
+  # Вызов курьера
+  def courier(data)
+    ensure_session_state
+    data = data.clone
+    data['SessionId'] = @session_id
+    res = json_request(:courier, data)
+    check_for_error(res, 'ErrorMessage', CourierError)
+  end
+
+  # Отмена вызова курьера
+  def courier_cancel(courier_order_number)
+    ensure_session_state
+    data = attach_session_id('OrderNumber', courier_order_number)
+    res = json_request(:courier_cancel, data)
+    res['Canceled']
+  end
+
+  # Формирование реестра по списку отправлений в PDF
+  def make_reestr(invoice_id)
+    request_by_invoice_ids(invoice_id, :make_reestr)
+  end
+
+  # Формирование реестра (по списку отправлений)
+  def make_reestr_number(invoice_ids)
+    ensure_session_state
+    response = request_by_invoice_ids(invoice_ids, :make_reestr_number)
+    res = JSON.parse(response)
+    check_for_error(res, 'ErrorMessage')
+    res['Numbers']
+  end
+
+  # Получение созданного реестра в PDF
+  def get_reestr(invoice_id = nil, reestr_number = nil)
+    ensure_session_state
+    data = {
+      'SessionId' => @session_id
+    }
+    data['InvoiceNumber'] = invoice_id if !invoice_id.nil?
+    data['ReestrNumber'] = reestr_number if !reestr_number.nil?
+    response = execute_action(:get_reestr, data)
+
+    if response.start_with?('Error')
+      raise ApiError, response
+    else
+      return response
+    end
+  end
+
+  # Формирование этикеток в PDF
+  def make_label(invoice_id)
+    request_by_invoice_ids(invoice_id, :make_label)
+  end
+
+  # Формирование этикеток в PDF для принтера Zebra
+  def make_zlabel(invoice_id)
+    request_by_invoice_ids(invoice_id, :make_zlabel)
+  end
+
+  # Получение списка городов
+  def city_list
+    parameterless_request(:city_list)
+  end
+
+  # Получение списка терминалов
+  def postamat_list
+    parameterless_request(:postamat_list)
+  end
+
+  # Получение информации по зонам
+  def get_zone(city, pt = nil)
+    ensure_session_state
+    data = {
+      'SessionId' => @session_id,
+      'FromCity' => city
+    }
+
+    if !pt.nil?
+      data['ToPT'] = pt
+    end
+
+    json_request(:get_zone, data)
+  end
+
+  # Получение акта возврата денег
+  def get_money_return_order(ikn, document_number, date_from, date_to = DateTime.now)
+    return_request(:get_money_return_order, ikn, document_number, date_from, date_to)
+  end
+
+  # Получение акта возврата товара
+  def get_product_return_order(ikn, document_number, date_from, date_to = DateTime.now)
+    return_request(:get_product_return_order, ikn, document_number, date_from, date_to)
+  end
+
+  # Получение информации по вложимому
+  def enclose_info(barcode)
+    ensure_session_state
+    data = attach_session_id('Barcode', barcode)
+    res = json_request(:enclose_info, data)
+    check_for_error(res, 'Error')
+  end
+
+  # Получение истории по списку отправлений
+  def track_sendings(invoice_id)
+    request_by_invoice_ids(invoice_id, :track_sendings)
+  end
+
+  # Получение справочника статусов отправления
+  def get_states
+    parameterless_request(:get_states)
+  end
+
+  # Получение списка отправлений, прошедших этап (статус)
+  def get_invoices_change_state(state, date_from, date_to = DateTime.now)
+    ensure_session_state
+    data = {
+      'SessionId' => @session_id,
+      'DateFrom' => date_from.strftime(DATE_FORMAT),
+      'DateTo' => date_to.strftime(DATE_FORMAT),
+      'State' => state
+    }
+    json_request(:get_invoices_change_state, data)
+  end
+
+end

data/lib/pickpoint_api/constants.rb

@@ -4,6 +4,8 @@ module PickpointApi::Constants
   API_TEST_PATH = '/apitest'
   API_PROD_PATH = '/api'
 
+  DATE_FORMAT = '%d.%m.%y'
+
   ACTIONS = {
     login:
     {

data/lib/pickpoint_api/exceptions.rb

@@ -1,5 +1,9 @@
 module PickpointApi::Exceptions
 
   ApiError = Class.new(StandardError)
-
+  InvalidSessionState = Class.new(ApiError)
+  LoginError = Class.new(ApiError)
+  LogoutError = Class.new(ApiError)
+  UnknownApiAction = Class.new(ApiError)
+  CourierError = Class.new(ApiError)
 end

data/lib/pickpoint_api/session.rb

@@ -1,7 +1,10 @@
-require('net/http')
-require('json')
+require_relative('api_actions.rb')
 
 class PickpointApi::Session
+  include(::PickpointApi::Exceptions)
+  include(::PickpointApi::Constants)
+  include(::PickpointApi::ApiActions)
+
   attr_reader :state
   attr_reader :test
 
@@ -10,130 +13,101 @@ class PickpointApi::Session
     @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)
+  private
 
-    if response['ErrorMessage'].nil? && !response['SessionId'].nil?
-      @session_id = response['SessionId']
-      @state = :started
+  def check_for_error(response, error_field, error = ApiError)
+    if !response[error_field].nil? && !response[error_field].empty?
+      yield if block_given?
+      raise error, response[error_field]
     else
-      @state = :error
-      raise ::PickpointApi::Exceptions::ApiError, response['ErrorMessage']
+      response
     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
+  def sendings_request(action, data)
+    ensure_session_state
+    data = attach_session_id(data, 'Sendings')
+    json_request(action, data)
   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
+  def parameterless_request(action)
+    ensure_session_state
+    response = execute_action(action)
+    JSON.parse(response)
   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
+  def ensure_session_state(state = :started)
+    if @state != state
+      raise InvalidSessionState
     end
-
-    response = JSON.parse(response)
   end
 
-  def postamat_list
-    if @state == :started
-      response = execute_action(:postamat_list)
-      response = JSON.parse(response)
-    end
+  def json_request(action, data)
+    response = execute_action(action, data)
+    JSON.parse(response)
   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]
+  def request_by_invoice_ids(invoice_ids, action)
+    ensure_session_state
+    data = if invoice_ids.kind_of?(Array)
+      invoice_ids
+    else
+      [invoice_ids]
     end
 
     data = attach_session_id(data,'Invoices')
-    response = execute_action(:make_label, data)
+    response = execute_action(action, data)
 
-    if response.start_with?("Error")
-      raise ::PickpointApi::Exceptions::ApiError, response
-      return nil
+    if response.start_with?('Error')
+      raise ApiError, response
     else
       return response
     end
   end
 
-  def make_reestr(invoice_id)
-    if @state != :started
-      return nil
-    end
+  def return_request(action, ikn, document_number, date_from, date_to = DateTime.now)
+    ensure_session_state
+    data = {
+      'SessionId' => @session_id,
+      'IKN' => ikn,
+      'DocumentNumber' => document_number,
+      'DateFrom' => date_from.strftime(DATE_FORMAT),
+      'DateEnd' => date_to.strftime(DATE_FORMAT)
+    }
+    json_request(action, data)
+    check_for_error(res, 'Error')
+  end
 
-    if invoice_id.kind_of?(Array)
-      data = invoice_id
-    elsif
-      data = [invoice_id]
-    end
+  def request_by_invoice_id(action, invoice_id = nil, sender_invoice_number = nil)
+    ensure_session_state
+    data = {
+      'SessionId' => @session_id
+    }
 
-    data = attach_session_id(data,'Invoices')
-    response = execute_action(:make_reestr, data)
+    if !invoice_id.nil?
+      data['InvoiceNumber'] = invoice_id
+    end
 
-    if response.start_with?("Error")
-      raise ::PickpointApi::Exceptions::ApiError, response
-      return nil
-    else
-      return response
+    if !sender_invoice_number.nil?
+      data['SenderInvoiceNumber'] = sender_invoice_number
     end
-  end
 
-  private
+    json_request(action, data)
+  end
 
   def api_path
     if @test
-      ::PickpointApi::Constants::API_TEST_PATH
+      API_TEST_PATH
     else
-      ::PickpointApi::Constants::API_PROD_PATH
+      API_PROD_PATH
     end
   end
 
   def create_request(action)
-    action_config = ::PickpointApi::Constants::ACTIONS[action]
+    action_config = ACTIONS[action]
+
     if action_config.nil?
-      return nil
+      raise UnknownApiAction, action
     end
 
     action_path = "#{api_path}#{action_config[:path]}"
@@ -145,7 +119,6 @@ class PickpointApi::Session
     end
 
     req.content_type = 'application/json'
-
     req
   end
 
@@ -157,23 +130,36 @@ class PickpointApi::Session
   end
 
   def execute_action(action, data = {})
-    req = create_request action
-
-    if req.nil?
-      return nil
-    end
-
+    logger.debug("Request: action: #{action}; data: #{data.inspect}")
+    req = create_request(action)
     req.body = data.to_json
-
     response = send_request(req)
+    log_response(response)
+
+    if response.code != '200'
+      raise ApiError, response.body
+    end
 
     response.body
   end
 
   def send_request(req)
-    ::Net::HTTP.start(::PickpointApi::Constants::API_HOST, ::PickpointApi::Constants::API_PORT) do |http|
+    ::Net::HTTP.start(API_HOST, API_PORT) do |http|
       http.request(req)
     end
   end
 
+  def log_response(response)
+    if !response.body.nil?
+      if response.body.start_with?('%PDF')
+        logger.debug("Response: #{response.code}; data: PDF")
+      else
+        logger.debug("Response: #{response.code}; data: #{response.body[0,200]}#{response.body.size > 200 ? '...' : ''}")
+      end
+    end
+  end
+
+  def logger
+    ::PickpointApi.logger
+  end
 end

data/pickpoint_api.gemspec

@@ -1,6 +1,8 @@
+require_relative('./lib/pickpoint_api.rb')
+
 Gem::Specification.new do |s|
   s.name = "pickpoint_api"
-  s.version = "0.1"
+  s.version = ::PickpointApi::VERSION
   s.authors = ["Kinderly LTD"]
   s.email = ["nuinuhin@gmail.com"]
   s.homepage = "http://github.com/kinderly/pickpoint_api"

data/spec/pickpoint_api/session_spec.rb

@@ -0,0 +1,137 @@
+require_relative '../spec_helper.rb'
+
+include DummyData
+
+describe ::PickpointApi::Session do
+
+  before(:each) do
+    ::HttpMocking.clear_response_queue
+    @session = ::PickpointApi::Session.new(test: true)
+    ::HttpMocking.enqueue_response(LOGIN_SUCCESSFUL)
+    @session.login('login', 'password')
+  end
+
+  it 'should create instance' do
+    @session = ::PickpointApi::Session.new(test: true)
+    expect(@session).not_to be_nil
+    expect(@session.test).to eq true
+    expect(@session.state).to eq :new
+  end
+
+  it 'should raise error on invalid session state' do
+    ::HttpMocking.enqueue_response(LOGOUT_SUCCESSFUL)
+    @session.logout
+    expect {@session.city_list}.to raise_error ::PickpointApi::Exceptions::InvalidSessionState
+  end
+
+  describe '.login' do
+    it 'should log-in' do
+      expect(@session.state).to eq :started
+    end
+
+    it 'should handle incorrect login' do
+      @session = ::PickpointApi::Session.new(test: true)
+      ::HttpMocking.enqueue_response(LOGIN_FAILED)
+      expect { @session.login('login', 'password') }.to raise_error ::PickpointApi::Exceptions::LoginError
+      expect(@session.state).to eq(:error)
+    end
+  end
+
+  describe '.logout' do
+    it 'should log out' do
+      ::HttpMocking.enqueue_response(LOGOUT_SUCCESSFUL)
+      @session.logout
+      expect(@session.state).to eq(:closed)
+    end
+
+    it 'should raise error on logout fail' do
+      ::HttpMocking.enqueue_response(LOGOUT_FAIL)
+      expect{@session.logout}.to raise_error ::PickpointApi::Exceptions::LogoutError
+      expect(@session.state).to eq(:error)
+    end
+  end
+
+  describe '.create_sending' do
+    it 'should handle successfull request' do
+      ::HttpMocking.enqueue_response(CREATE_SENDING_SUCCESSFUL)
+      res = @session.create_sending(SAMPLE_SENDING_REQUEST)
+      expect(res['CreatedSendings']).not_to be_empty
+      expect(res['RejectedSendings']).to be_empty
+    end
+  end
+
+  [:track_sending, :sending_info].each do |m|
+    describe ".#{m}" do
+      it 'should handle successfull request' do
+        ::HttpMocking.enqueue_response({}.to_json)
+        res = @session.send(m, '21121312')
+      end
+    end
+  end
+
+  [:make_label, :make_zlabel, :make_reestr].each do |m|
+    describe ".#{m}" do
+      it 'should handle successfull request' do
+        ::HttpMocking.enqueue_response(PDF_SUCCESS)
+        @session.send(m, '12345')
+      end
+
+      it 'should handle multiple invoices' do
+        ::HttpMocking.enqueue_response(PDF_SUCCESS)
+        @session.send(m, ['123123','123213'])
+      end
+
+      it 'should handle api error' do
+        ::HttpMocking.enqueue_response(PDF_ERROR)
+        expect{@session.send(m, ['123123'])}.to raise_error PickpointApi::Exceptions::ApiError
+      end
+    end
+  end
+
+  describe '.city_list' do
+    it 'should handle successfull request' do
+      ::HttpMocking.enqueue_response(CITY_LIST_SUCCESS)
+      res = @session.city_list
+      expect(res.count).to eq(2)
+    end
+  end
+
+  describe '.get_states' do
+    it 'should handle successfull request' do
+      ::HttpMocking.enqueue_response(STATES_SUCCESS)
+      res = @session.get_states
+      expect(res.count).to eq(3)
+    end
+  end
+
+  describe '.postamat_list' do
+    it 'should handle successfull request' do
+      ::HttpMocking.enqueue_response({}.to_json)
+      @session.postamat_list
+    end
+  end
+
+  describe '.get_zone' do
+    it 'should handle successfull request' do
+      ::HttpMocking.enqueue_response(ZONES_SUCCESS)
+      res = @session.get_zone('Some city', '7801-035')
+      expect(res['Error']).to be_nil
+    end
+  end
+
+  describe '.get_invoices_change_state' do
+    it 'should handle successfull request' do
+      ::HttpMocking.enqueue_response(GET_STATE_SUCCESS)
+      res = @session.get_invoices_change_state(102, DateTime.parse('2014-01-01'), DateTime.parse('2014-03-01'))
+      expect(res.count).to eq(1)
+    end
+  end
+
+  describe '.courier' do
+    it 'should handle successfull request' do
+      ::HttpMocking.enqueue_response('{}')
+      res = @session.courier({})
+    end
+  end
+
+end

data/spec/pickpoint_api_spec.rb

@@ -0,0 +1,48 @@
+require('logger')
+require_relative 'spec_helper.rb'
+
+include DummyData
+
+describe 'PickpointApi' do
+  before(:each) do
+    HttpMocking.clear_response_queue
+  end
+
+  it 'should run session' do
+    HttpMocking.enqueue_response(LOGIN_SUCCESSFUL)
+    HttpMocking.enqueue_response(LOGOUT_SUCCESSFUL)
+
+    PickpointApi.session('login', 'password', test:true) do |s|
+    end
+  end
+
+  it 'should write logs' do
+    PickpointApi.logger.level = Logger::UNKNOWN
+    PickpointApi.logger.info('INFO')
+    PickpointApi.logger.error('ERROR')
+    PickpointApi.logger.warn('WARNING')
+    PickpointApi.logger.fatal('FATAL')
+    PickpointApi.logger.debug('DEBUG')
+  end
+
+  it 'should assign logger' do
+    PickpointApi.logger = nil
+    PickpointApi.logger = Logger.new($stderr)
+    expect(PickpointApi.logger).not_to be_nil
+  end
+
+  it 'should handle session error' do
+    PickpointApi.logger.level = Logger::UNKNOWN
+
+    HttpMocking.enqueue_response(LOGIN_SUCCESSFUL)
+    HttpMocking.enqueue_response(PDF_ERROR)
+    HttpMocking.enqueue_response(LOGOUT_SUCCESSFUL)
+
+    expect do
+      PickpointApi.session('login', 'password', test:true) do |s|
+        s.make_label('111111')
+      end
+    end.to raise_error PickpointApi::Exceptions::ApiError
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,7 @@
+require 'coveralls'
+Coveralls.wear!
+
+require_relative './support/dummy_data.rb'
+require_relative './support/http_mocking.rb'
+require_relative '../lib/pickpoint_api.rb'
+

data/spec/support/dummy_data.rb

@@ -3,43 +3,89 @@
 require ('json')
 
 module DummyData
-  LOGIN_SUCCESSFULL = {'SessionId' => '111111111'}.to_json
+
+  LOGIN_SUCCESSFUL = {'SessionId' => '111111111'}.to_json
+
   LOGIN_FAILED = {'ErrorMessage' => 'Неверный логин или пароль'}.to_json
-  LOGOUT_SUCCESSFULL = {'Success' => true}.to_json
-  CREATE_SENDING_SUCCESSFULL = {
-    "CreatedSendings" => [
+
+  LOGOUT_SUCCESSFUL = {'Success' => true}.to_json
+  LOGOUT_FAIL = {'Success' => false}.to_json
+
+  CREATE_SENDING_SUCCESSFUL = {
+    'CreatedSendings' => [
       {
-        'EDTN' => "14",
-        'IKN' => "9990000000",
+        'EDTN' => '14',
+        'IKN' => '9990000000',
         'Barcode' => '200819647155'
       }
     ],
-    "RejectedSendings" => []
+    'RejectedSendings' => []
+  }.to_json
+
+  PDF_SUCCESS = '%PDF'
+
+  PDF_ERROR = 'Error: Произошла ошибка'
+
+  CITY_LIST_SUCCESS = [
+    {'Id'=>3926841, 'Name'=>'Борзые', 'Owner_Id'=>923, 'RegionName'=>'Московская обл.'},
+    {'Id'=>3940057, 'Name'=>'Северный', 'Owner_Id'=>5, 'RegionName'=>'Московская обл.'}
+  ].to_json
+
+  STATES_SUCCESS = [
+    {'State'=>101, 'StateText'=>'Зарегистрирован'},
+    {'State'=>102, 'StateText'=>'Сформирован для передачи Логисту'},
+    {'State'=>103, 'StateText'=>'Развоз до ПТ самостоятельно'}
+  ].to_json
+
+  ZONES_SUCCESS = {
+    'Error' => nil,
+    'Zones' => [
+      {
+        'DeliveryMax' => 2,
+        'DeliveryMin' => 1,
+        'FromCity' => 'Химки',
+        'Koeff' => 1,
+        'ToCity' => 'Санкт-Петербург',
+        'ToPT' => '7801-035',
+        'Zone' => '0'
+      }
+    ]
   }.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" => [
+  GET_STATE_SUCCESS = [
+    {
+      "ChangeDT" => "16.01.14 00:28",
+      "State" => 112,
+      "StateMessage" => "Невостребованное",
+      "InvoiceNumber"=>"0000000000000",
+      "SenderInvoiceNumber"=>"00000"
+    }
+  ].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
+            'Line' => 1,
+            'ProductCode' => 4559802,
+            'GoodsCode' => '79380-555',
+            'Name' => 'Fire extinguisher large',
+            'Price' => 4290.0
           }]
       }
-  }
+  }]
 
 end

data/spec/support/http_mocking.rb

@@ -1,12 +1,19 @@
 require 'net/http'
 
-
 module HttpMocking
 
-  def self.set_next_response(response_body, code = 200, msg='OK')
+  def self.clear_response_queue
+    @responses = []
+  end
+
+  def self.enqueue_response(response_body, code = '200', msg='OK')
+    @responses ||= []
+    @responses.push([response_body, code, msg])
+
     Net::HTTP.any_instance.stub(:request) do |req|
-      response = Net::HTTPResponse.new(1.0, code, msg)
-      response.stub(:body => response_body)
+      next_response = @responses.shift
+      response = Net::HTTPResponse.new(1.0, next_response[1], next_response[2])
+      response.stub(:body => next_response[0])
       response
     end
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pickpoint_api
 version: !ruby/object:Gem::Version
-  version: '0.1'
+  version: '0.2'
 platform: ruby
 authors:
 - Kinderly LTD
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-03-03 00:00:00.000000000 Z
+date: 2014-03-08 00:00:00.000000000 Z
 dependencies: []
 description: This gem provides a Ruby wrapper over Pickpoint API.
 email:
@@ -18,16 +18,19 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- ".rspec"
 - ".travis.yml"
 - LICENSE
 - README.md
 - lib/pickpoint_api.rb
+- lib/pickpoint_api/api_actions.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/pickpoint_api/session_spec.rb
+- spec/pickpoint_api_spec.rb
+- spec/spec_helper.rb
 - spec/support/dummy_data.rb
 - spec/support/http_mocking.rb
 homepage: http://github.com/kinderly/pickpoint_api

data/spec/pickpoint_api.rb

@@ -1,15 +0,0 @@
-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

@@ -1,111 +0,0 @@
-# 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