tmapi 0.0.1 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: '018b9a91fe49e1bd5b08bcbd881f1f461ece20d0'
-  data.tar.gz: 900a42a3678da59e534fe0e2bac78d549644a052
+  metadata.gz: 8ac0b0b782dc03babc7598a1e3d819886124bbf1
+  data.tar.gz: 7bac6a87072199331b0bd2fa469fa8cb20f180cb
 SHA512:
-  metadata.gz: 53b5401c92659815fcc766590f1bb78dd2d43e0e0000d1f9f9b885ea548dc9ca79178aca349ad68e2f303ffe630d26a53214d3264aaa8a6951cf782ac0f24203
-  data.tar.gz: 8ac13fa0282fa301d07838f1e4c4bca7fd2863fa032298a4c09fa72d1857bd5d1d0494d8ed51682a78b4c871e96c75c5b56cb2fe4f9f67f2910c4044246b6469
+  metadata.gz: 303dbc325e66689a5d7eef3919da7b53bcd4f395bbb982af8a6ab566eff0439e84f8f70daa7e54db6de144fa460a5e096f16d93fa7877533f86bf4fe136427c5
+  data.tar.gz: 93e1343146381d3a152e771f7d585623445950a138c7b312a010f9473de8f8a034b6792fcd98e9d23a33cc5328672bec1ed73d515c0bc89523f8d41d085ebfc9

data/Gemfile.lock

@@ -1,14 +1,16 @@
 PATH
   remote: .
   specs:
-    tmapi (0.0.1)
+    tmapi (0.0.3)
 
 GEM
   remote: https://rubygems.org/
   specs:
     addressable (2.5.0)
       public_suffix (~> 2.0, >= 2.0.2)
+    ansi (1.5.0)
     ast (2.3.0)
+    builder (3.2.3)
     crack (0.4.3)
       safe_yaml (~> 1.0.0)
     hashdiff (0.3.2)
@@ -16,6 +18,11 @@ GEM
       multi_xml (>= 0.5.2)
     mini_portile2 (2.1.0)
     minitest (5.10.1)
+    minitest-reporters (1.1.14)
+      ansi
+      builder
+      minitest (>= 5.0)
+      ruby-progressbar
     multi_xml (0.5.5)
     nokogiri (1.6.8.1)
       mini_portile2 (~> 2.1.0)
@@ -46,6 +53,7 @@ DEPENDENCIES
   bundler (~> 1.13)
   httparty
   minitest (~> 5.0)
+  minitest-reporters (~> 1.1)
   nokogiri
   rake (~> 10.0)
   rubocop (~> 0)

data/README.md

@@ -1,6 +1,11 @@
-# TmAPI
+# TMAPI
 
-Wrapper for TM API ([Taxi Master](http://taxi-master.com)) written in Ruby.
+[![Build Status](https://travis-ci.org/rgarifullin/tmapi.svg?branch=master)](https://travis-ci.org/rgarifullin/tmapi)
+[![Code Climate](https://codeclimate.com/github/rgarifullin/tmapi/badges/gpa.svg)](https://codeclimate.com/github/rgarifullin/tmapi)
+
+Wrapper for TaxiMaster API ([Taxi Master](http://taxi-master.com)) written in Ruby.
+
+TaxiMaster API documentation: [(Russian)](http://help.taximaster.ru/index.php/TM_API)
 
 ## Installation
 
@@ -24,13 +29,18 @@ First you should initialize a new class with API URL and unique key of customer.
 
 Example:
 ```ruby
-api = TMAPI('url', 'key')
+api = TMAPI::Telephony.new('url', 'key')
 api.change_order_state(order_id, new_state)
+# if OK
+=> { order_id: 1, new_state: 5 }
 ```
 
-Optionally you can disable SSL verification (enabled by default):
+Options:
+* ```ssl``` - SSL verification (```true``` by default)
+* ```debug``` - output response to logger (```false``` by default)
+
 ```ruby
-api = TMAPI('url', 'key', false)
+api = TMAPI::Telephony.new('url', 'key', ssl: false, debug: true)
 ```
 
 ## Contributing

data/lib/tmapi/common.rb

@@ -0,0 +1,5 @@
+module TMAPI
+  # TaxiMaster Common API
+  class Common
+  end
+end

data/lib/tmapi/telephony.rb

@@ -0,0 +1,80 @@
+require 'httparty'
+require 'nokogiri'
+require 'logger'
+
+module TMAPI
+  # TaxiMaster Telephony API
+  class Telephony
+    class Error < RuntimeError; end
+    class OrderNotFound < Error; end
+    class FailedRequirements < Error; end
+
+    def initialize(url, key, opts = {})
+      @url = url
+      @key = key
+      @verify_ssl = opts[:ssl] || true
+      @logger = TMAPI::Telephony.logger || Logger.new(STDOUT)
+      @debug = opts[:debug] || false
+    end
+
+    def change_order_state(order_id, state)
+      params = { order_id: order_id, need_state: state }
+      params[:signature] = signature(params)
+
+      opts = { body: params, verify: @verify_ssl, format: :plain }
+      response = HTTParty.post("#{@url}/change_order_state", opts)
+      @logger.debug(response) if @debug
+
+      parse_change_order_state(response, order_id)
+    end
+
+    private
+
+    class << self
+      attr_accessor :logger
+    end
+
+    if defined?(Rails::Railtie)
+      # Use Rails.logger inside Rails app
+      class Railtie < Rails::Railtie
+        initializer 'TMAPI::Telephony.logger' do
+          TMAPI::Telephony.logger = Rails.logger
+        end
+      end
+    end
+
+    def url_params(params)
+      URI.encode_www_form(params)
+    end
+
+    def signature(params)
+      Digest::MD5.hexdigest(url_params(params) + @key)
+    end
+
+    def inspect(data)
+      data.each_with_object({}) do |elem, hash|
+        hash[elem.name.downcase.to_sym] = if elem.elements.any?
+                                            inspect(elem.elements)
+                                          else
+                                            elem.text
+                                          end
+      end
+    end
+
+    def parse_change_order_state(response, order_id)
+      data = Nokogiri::XML(response.body).root
+      return {} unless data
+
+      parsed_response = inspect(data.elements)
+      case parsed_response[:code]
+      when '100'
+        raise OrderNotFound.new, "Order ID #{order_id} not found"
+      when '101'
+        raise FailedRequirements.new,
+              "Can't change state of order ID #{order_id} due to requirements"
+      end
+
+      parsed_response[:data]
+    end
+  end
+end

data/tmapi.gemspec

@@ -4,12 +4,12 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 
 Gem::Specification.new do |spec|
   spec.name          = 'tmapi'
-  spec.version       = '0.0.1'
+  spec.version       = '0.0.3'
   spec.authors       = ['Rinat Garifullin']
   spec.email         = ['ringarifullin@gmail.com']
 
-  spec.summary       = 'Wrapper for TM API'
-  spec.description   = 'Wrapper for TM HTTP API http://taxi-master.com/'
+  spec.summary       = 'Wrapper for TaxiMaster API (TMAPI)'
+  spec.description   = 'Wrapper for TaxiMaster HTTP API http://taxi-master.com/'
   spec.homepage      = 'https://github.com/rgarifullin/tmapi'
   spec.license       = 'MIT'
 
@@ -23,6 +23,7 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'bundler', '~> 1.13'
   spec.add_development_dependency 'rake', '~> 10.0'
   spec.add_development_dependency 'minitest', '~> 5.0'
+  spec.add_development_dependency 'minitest-reporters', '~> 1.1'
   spec.add_development_dependency 'webmock', '~> 2.3'
   spec.add_development_dependency 'rubocop', '~> 0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: tmapi
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.3
 platform: ruby
 authors:
 - Rinat Garifullin
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-03-21 00:00:00.000000000 Z
+date: 2017-04-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -52,6 +52,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: minitest-reporters
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
 - !ruby/object:Gem::Dependency
   name: webmock
   requirement: !ruby/object:Gem::Requirement
@@ -80,7 +94,7 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0'
-description: Wrapper for TM HTTP API http://taxi-master.com/
+description: Wrapper for TaxiMaster HTTP API http://taxi-master.com/
 email:
 - ringarifullin@gmail.com
 executables: []
@@ -98,7 +112,8 @@ files:
 - Rakefile
 - bin/console
 - bin/setup
-- lib/tmapi.rb
+- lib/tmapi/common.rb
+- lib/tmapi/telephony.rb
 - tmapi.gemspec
 homepage: https://github.com/rgarifullin/tmapi
 licenses:
@@ -123,5 +138,5 @@ rubyforge_project:
 rubygems_version: 2.5.2
 signing_key: 
 specification_version: 4
-summary: Wrapper for TM API
+summary: Wrapper for TaxiMaster API (TMAPI)
 test_files: []

data/lib/tmapi.rb

@@ -1,53 +0,0 @@
-require 'httparty'
-require 'nokogiri'
-require 'logger'
-
-class TMAPI
-  def initialize(url, key, ssl = true)
-    @url = url
-    @key = key
-    @ssl = ssl
-    @logger = TMAPI.logger || Logger.new(STDOUT)
-  end
-
-  def change_order_state(order_id, state)
-    params = { order_id: order_id, need_state: state }
-    params[:signature] = signature(params)
-
-    begin
-      response = HTTParty.post("#{@url}/change_order_state", body: params,
-                                                             verify: @ssl)
-      result = Nokogiri::XML(response.body)
-      if response.success? && result.at_css('code')&.content.to_i.zero?
-        result.at_css('data')&.at_css('NEW_STATE')&.content.to_i == state
-      else
-        false
-      end
-    rescue Errno::ECONNREFUSED => ex
-      @logger.fatal(ex)
-      false
-    end
-  end
-
-  private
-
-  class << self
-    attr_accessor :logger
-  end
-
-  def url_params(params)
-    URI.encode_www_form(params)
-  end
-
-  def signature(params)
-    Digest::MD5.hexdigest(url_params(params) + @key)
-  end
-
-  if defined?(Rails::Railtie)
-    class Railtie < Rails::Railtie
-      initializer 'TmAPI.logger' do
-        TMAPI.logger = Rails.logger
-      end
-    end
-  end
-end