moysklad 0.2.1 → 0.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 0d4466dae399f6e8ec4819ce0c42eb53c9efafb6
-  data.tar.gz: 6652461f2c0a089662cbe54e608da6f9e500e6a1
+SHA256:
+  metadata.gz: 6fad3cc93541b8fa239ed1a6e3e7a900d2206117589163067f85289abb0261b3
+  data.tar.gz: bc7c87f9765092342522ffba77d6178c00f670e4e8f5363f77f7055c17a80f9d
 SHA512:
-  metadata.gz: 8400a264b733e8eb015d072de499eb6f0896e15a6b1f7d2f095d5c2bc9968c23ce6710db3853b08e1a916b025267c21277dc6a7a16bebf4ff5c4cf57cc29d121
-  data.tar.gz: 32ba29c475f85b439b3f5239225c854762c93988d80d332112d163b02a7a7103ead308a1458ad964f555db63f394e5223780aad79a7bd798a5d5fefb3b6ad812
+  metadata.gz: 2149b17c96a6dcf5a8006f16173739caeb4745f0055921d548d46b9c084a4fc083d6f644e6ff6407cdd7f0563be0fdff43f84e37b3b7a7c77568a16127b09ad6
+  data.tar.gz: 5f3ad953ea673c0e69d1fef4405ab5711e8cd603c88a93fa57ac49cda7f2fd8353723da25abcc6b54076416dbc5b5858ed39d1738cb223cde9414a200505126d

data/.github/workflows/rspec.yml

@@ -0,0 +1,29 @@
+# This workflow uses actions that are not certified by GitHub.
+# They are provided by a third-party and are governed by
+# separate terms of service, privacy policy, and support
+# documentation.
+# This workflow will download a prebuilt Ruby version, install dependencies and run tests with Rake
+# For more information see: https://github.com/marketplace/actions/setup-ruby-jruby-and-truffleruby
+
+name: Rspec
+
+on:
+  push:
+    branches: [ master ]
+  pull_request:
+    branches: [ master ]
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    steps:
+    - name: Checkout repository and submodules
+      uses: actions/checkout@v2
+      with:
+        submodules: recursive
+    - name: Set up Ruby
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: 3.1.4
+        bundler-cache: true # runs 'bundle install' and caches installed gems automatically
+    - run: bundle exec rspec

data/.gitignore

@@ -1,4 +1,5 @@
 *.gem
+.byebug_history
 *.rbc
 tags
 gems.tags

data/README.md

@@ -1,8 +1,8 @@
 #  Ruby-клиент для REST XML API Moysklad
 
-[![Build Status](https://travis-ci.org/BrandyMint/moysklad.svg)](https://travis-ci.org/BrandyMint/moysklad)
+[![Build Status](https://travis-ci.org/BrandyMint/moysklad.svg)](https://travis-ci.org/dapi/moysklad)
 [![Dependency Status](https://www.versioneye.com/user/projects/548225818674a4b5b90004dd/badge.svg?style=flat)](https://www.versioneye.com/user/projects/548225818674a4b5b90004dd)
-[![Code Climate](https://codeclimate.com/github/BrandyMint/moysklad/badges/gpa.svg)](https://codeclimate.com/github/BrandyMint/moysklad)
+[![Code Climate](https://codeclimate.com/github/dapi/moysklad/badges/gpa.svg)](https://codeclimate.com/github/dapi/moysklad)
 
 * http://www.rubydoc.info/gems/moysklad
 
@@ -12,8 +12,9 @@
 * Все используемые сущности описаны и структурированы. Например [Good](lib/moysklad/entities/good.rb)
 * Любые действия с ресурсами (Create, Read, Update, Delete, List).
 * Виртуальные действия с ресурсами (`where`, `findWhere`)
+* Автоматическая подгрузка списка если все данные не уместились в один запрос (метод `all`)
 * _Кеширование и предзагрузка_ ресурса со всеми записями (используем ресурс как локальную базу)
-* Работа с нескольмими аккаунтами на склада одновременно (отсуствие глобальных переменных).
+* Работа с нескольмими аккаунтами склада одновременно (отсуствие глобальных переменных).
 * Удобная работа с подресурсами (например справочником свойств товара)
 * _Ассоциации_ между сущностями автоматически получают данные по API (`good.features`).
 * [Client](lib/moysklad/client.rb) для прямого обращения к API в случае крайней необходимости.
@@ -282,10 +283,20 @@ dictionary.entities(universe)
 
     > MS_LOGON=логин MS_PASSWORD=пароль ./script/rest.sh Country list > ./spec/fixtures/Country_list.raw
 
+Если получаете 429 ошибку (too many requests) - лимит обращений по API от одного
+аккаунта - 5 или 10 запросов в секунду (в секунду, Карл). Если не превышать его,
+все будет хорошо - минутных или часовых лимитов нет.
+
 ## Ссылочки
 
 * Картапамяти по API http://www.mindmeister.com/246618635/online-moysklad-ru
 * Документация для разработчииков https://support.moysklad.ru/hc/ru/sections/200561443-Разработчикам
+* Неплохая схема API в json https://gist.github.com/dapi/22a0790db19a4ff51a37
+
+## Другие биллиотеки
+
+* PHP https://github.com/Tooyz/moysklad
+* JavaScript/nodejs https://github.com/wmakeev/moysklad-client
 
 ## Присылайте пул-реквесты )
 

data/lib/moysklad/client/errors.rb

@@ -1,23 +1,44 @@
 class Moysklad::Client
   class Errors
     def self.build res
-      Moysklad.logger.warn "Moyskad::Client: #{res.status}: #{res.env.url.to_s}\n#{res.body}"
+      body = res.body.force_encoding('utf-8')
+      content_type = res.headers['content-type']
+
+      if content_type.start_with? 'application/json'
+        # ok
+      elsif content_type.start_with? 'text/html'
+        raise HtmlParsedError, body
+      else
+        raise UnknownError, body
+      end
+
+      # Encoding::UndefinedConversionError
+      # "\xD0" from ASCII-8BIT to UTF-8
+      begin
+        body = JSON.parse body
+        Moysklad.logger.debug "Moysklad::Client: #{res.status}: #{res.headers}, #{res.env.url.to_s}\n#{body}"
+      rescue Encoding::UndefinedConversionError => err
+        Moysklad.logger.error "#{err}"
+      rescue JSON::ParserError => err
+        Moysklad.logger.error "#{err}: #{res.headers}, body:#{body}"
+        raise ParsingError, body
+      end
 
       case res.status
-      when 401 
-        raise UnauthorizedError.new res
+      when 401
+        raise UnauthorizedError.new body
       when 403
-        raise ResourceForbidden.new res
-      when 404 
-        raise NoResourceFound.new res.body
-      when 405
-        raise MethodNotAllowedError.new res
+        raise ResourceForbidden.new body
+      when 404
+        raise NoResourceFound.new body
+      when 405, 412
+        raise MethodNotAllowedError.new body
       when 500
-        raise InternalServerError.new res
+        raise InternalServerError.new body
       when 502
-        raise BadGatewayError.new res
-      else 
-        raise ParsedError.new res
+        raise BadGatewayError.new body
+      else
+        raise JsonParsedError.new body
       end
     end
   end
@@ -32,39 +53,48 @@ class Moysklad::Client
     end
 
     def to_s
-      message
+      message.to_s.encode('utf-8')
+      # <?xml version="1.0" encoding="UTF-8"?> <error> <uid>kiiiosk@wannabemoscow</uid> <moment>20150609112728449</moment> <message>������������ ���� ���������� �������� ������������.</message> </error>
+    rescue Encoding::CompatibilityError
+      message.to_s.force_encoding('cp1251').encode('utf-8')
     end
   end
+  class ParsingError < Error; end
+
+  class UnknownError < Error; end
 
   class NoResourceFound < Error; end
 
+  class JsonParsedError < Error
+    def initialize result
+      super result.to_json
+    end
+
+    attr_reader :error
+  end
+
   class HtmlParsedError < Error
-    def initialize res
-      @result  = res
-      @message = "[#{res.status}] #{parse_title res.body}"
+    def initialize body
+      @message = parse_title body
     end
 
     private
 
     def parse_title body
-      doc = Nokogiri::HTML body
-      # у ResourceForbidden есть <u>
-      # у wrong_password <u> несколько
-      # Можно ошибку разбирать более грамотно по свойствам type, message, description: http://i.gyazo.com/e9d5d08bd610882d87f39d9002cdf25a.png
-      [doc.css('body').css('h1').text,doc.css('body').css('u').to_a.map(&:text).compact.last].join('; ')
+      Nokogiri::HTML(body).css('body').text
     rescue => err
-      Moysklad.logger.debug "Moyskad::Client parse error #{err}: #{body}"
+      Moysklad.logger.debug "Moysklad::Client parse error #{err}: #{body}"
       body.force_encoding('utf-8')
     end
   end
 
-  class MethodNotAllowedError < HtmlParsedError
+  class MethodNotAllowedError < JsonParsedError
   end
 
-  class UnauthorizedError < HtmlParsedError
+  class UnauthorizedError < JsonParsedError
   end
 
-  class ResourceForbidden < HtmlParsedError
+  class ResourceForbidden < JsonParsedError
   end
 
   class ParsedError < Error
@@ -72,24 +102,24 @@ class Moysklad::Client
       @status = result.status
       @result = result
       case result.headers['content-type']
-        
+
       when /application\/xml/
         @error = Moysklad::Entities::Error.parse result.body
         @message = @error.message
       when /text\/html/
-        doc = Nokogiri::HTML body
+        doc = Nokogiri::HTML result.body
         @message = doc.css('body').css('h1').text
       else
         raise "Unknown content-type #{result.headers['content-type']} to parse error #{result.body}"
       end
     rescue => err
-      @message = "error in init #{err}: #{result.body}"
+      @message = "error in init #{err}: #{result}"
     end
 
     attr_reader :error
   end
 
 
-  class BadGatewayError < HtmlParsedError; end
-  class InternalServerError < ParsedError; end
+  class BadGatewayError < JsonParsedError; end
+  class InternalServerError < JsonParsedError; end
 end

data/lib/moysklad/client.rb

@@ -4,31 +4,55 @@ require_relative 'client/errors'
 
 class Moysklad::Client
 
-  URL = 'https://online.moysklad.ru'
+  # URL = 'https://online.moysklad.ru'
+  URL  ='https://online.moysklad.ru/api/remap/1.1/'
 
   def initialize login: nil, password: nil
-    @client = Faraday.new URL
-    @client.basic_auth login, password
+    @client = Faraday.new URL do |conn|
+      conn.request(:authorization, :basic, login, password)
+    end
+  end
+
+  def download(path, filename)
+    response = client.get path
+    File.open(filename, 'wb') { |fp| fp.write(response.body) }
   end
 
   def get path, params={}
     logger.debug "Client: GET #{path} #{params}"
-    validate client.get path, params
+    parse_response client.get path, params
+  end
+
+  def post path, data
+    logger.debug "Client: POST #{path}"
+    result = client.post do |req|
+      req.url path
+      req.headers['Content-Type'] = 'application/json'
+      req.headers['Accept'] = '*/*'
+      req.body = data
+    end
+    parse_response result
   end
 
   def put path, data
     logger.debug "Client: PUT #{path}"
     result = client.put do |req|
       req.url path
-      req.headers['Content-Type'] = 'application/xml'
+      req.headers['Content-Type'] = 'application/json'
       req.headers['Accept'] = '*/*'
       req.body = data
     end
-    validate result
+    parse_response result
   end
 
   def delete path
-    validate client.delete path
+    logger.debug "Client: DELETE #{path}"
+    result = client.delete do |req|
+      req.url path
+      req.headers['Content-Type'] = 'application/json'
+      req.headers['Accept'] = '*/*'
+    end
+    parse_response result
   end
 
   private
@@ -39,10 +63,14 @@ class Moysklad::Client
     Moysklad.logger
   end
 
-  def validate res
-    return res.body if res.status == 200
+  def parse_response res
+    Moysklad.logger.debug "Response [#{res.status}]: #{res.body}"
 
-    Moysklad::Client::Errors.build res
+    if res.status == 200
+      return if res.body.blank?
+      JSON.parse res.body
+    else
+      Moysklad::Client::Errors.build res
+    end
   end
-
 end

data/lib/moysklad/entities/assortment.rb

@@ -0,0 +1,4 @@
+module Moysklad::Entities
+  class Assortment < Entity
+  end
+end

data/lib/moysklad/entities/attribute.rb

@@ -1,47 +1,121 @@
+# Атрибут товара (ссылка на его тип и его значение)
 module Moysklad::Entities
   class Attribute < Base
-    include Moysklad::Entities::Common
+    attribute :meta, Meta
+    attribute :id, String
+    attribute :name, String
+    attribute :customEntityMeta, Meta
+    attribute :type, String #attributemetadata
+    attribute :value, AttributeValue
+    attribute :required, Boolean
 
-    tag 'attribute'
+    def to_s
+      "#{name} (#{type}): #{value}"
+    end
 
-    attribute :metadataUuid,    String
-    attribute :valueString,     String
-    attribute :valueText,       String
+    def is_dictionary?
+      type == 'customentity'
+    end
 
-    attribute :entityValueUuid, String
+    ### Если это свойство типа ID_CUSTOM, то возвращается пользовательский справочник
+    ###
+    ### @return Moysklad::Entities::CustomEntityMetadata
+    ##def dictionatyMetadata universe
+    ##raise "Это свойства не типа справочник" unless dictionaryMetadataUuid
+    ##universe.custom_entity_metadata.find dictionaryMetadataUuid
+    ##end
 
-    # Объект описывающий тип атритуба
-    #
-    # @return Moysklad::Entities::AttributeMetadata
-    #
-    def metadata universe
-      universe.embedded_entity_metadata.subresource_by_name(:GoodFolder).find metadataUuid
-    end
+    ### Справочник к которому принадлежит это ссвойство
+    ###
+    ### @return Moysklad::Entities::EmbeddedEntityMetadata
+    ##def entityMetadata universe
+    ##universe.embedded_entity_metadata.find entityMetadataUuid
+    ##end
 
-    # Название свойства, полученное из AttributeMetadata
-    #
-    # @return String
-    #
-    def attributeName universe
-      metadata(universe).name
-    end
 
-    # Значение свойства согласно его типу
-    #
-    # @return [String | Moysklad::Entities::CustomEntity | Integer | Decimal ]
-    def get_value universe
-      md = metadata universe
-      case md.attrType
-      when 'ID_CUSTOM'
-        universe.custom_entities.find( entityValueUuid ).name
-      when 'TEXT'
-        valueText
-      when 'STRING'
-        valueString
-        # TODO Другие типы
-      else
-        raise "Не известный тип мета-аттрибута #{md.uuid}: #{md.attrType}"
-      end
-    end
+    ### Объект описывающий тип атритуба
+    ###
+    ### @return Moysklad::Entities::AttributeMetadata
+    ###
+    ##def metadata universe
+    ##universe.embedded_entity_metadata.subresource_by_name(:GoodFolder).find metadataUuid
+    ##end
+
+    ### Название свойства, полученное из AttributeMetadata
+    ###
+    ### @return String
+    ###
+    ##def attributeName universe
+    ##metadata(universe).name
+    ##end
+
+    ### Значение свойства согласно его типу
+    ###
+    ### @return [String | Moysklad::Entities::CustomEntity | Integer | Decimal ]
+    #def get_value universe
+      #md = metadata universe
+      #case md.attrType
+      #when 'ID_CUSTOM'
+        #universe.custom_entities.find( entityValueUuid ).name
+      #when 'LINK'
+        #valueText
+      #when 'TEXT'
+        #valueText
+      #when 'STRING'
+        #valueString
+      #when 'DOUBLE'
+        #doubleValue
+      #when 'LONG'
+        #longValue
+      #when 'TIME'
+        #timeValue
+      #when 'FILE'
+        #file
+      #else
+        #raise "Не известный тип мета-аттрибута #{md.uuid}: #{md.attrType}"
+      #end
+    #end
+    ### Объект описывающий тип атритуба
+    ###
+    ### @return Moysklad::Entities::AttributeMetadata
+    ###
+    ##def metadata universe
+    ##universe.embedded_entity_metadata.subresource_by_name(:GoodFolder).find metadataUuid
+    ##end
+
+    ### Название свойства, полученное из AttributeMetadata
+    ###
+    ### @return String
+    ###
+    ##def attributeName universe
+    ##metadata(universe).name
+    ##end
+
+    ### Значение свойства согласно его типу
+    ###
+    ### @return [String | Moysklad::Entities::CustomEntity | Integer | Decimal ]
+    ##def get_value universe
+    ##md = metadata universe
+    ##case md.attrType
+    ##when 'ID_CUSTOM'
+    ##universe.custom_entities.find( entityValueUuid ).name
+    ##when 'LINK'
+    ##valueText
+    ##when 'TEXT'
+    ##valueText
+    ##when 'STRING'
+    ##valueString
+    ##when 'DOUBLE'
+    ##doubleValue
+    ##when 'LONG'
+    ##longValue
+    ##when 'TIME'
+    ##timeValue
+    ##when 'FILE'
+    ##file
+    ##else
+    ##raise "Не известный тип мета-аттрибута #{md.uuid}: #{md.attrType}"
+    ##end
+    ##end
   end
 end

data/lib/moysklad/entities/attribute_metadata.rb

@@ -1,38 +1,14 @@
 module Moysklad::Entities
-  # https://online.moysklad.ru/exchange/rest/ms/xml/Metadata/list
   class AttributeMetadata < Base
-    include CommonObject
-
-    tag 'attributeMetadata'
-
-    # ID_CUSTOM - элемент из dictionary
-    # TEXT
-    # STRING
-    attribute :attrType,            String
-    attribute :entityMetadataUuid,  String
-    attribute :feature,             Boolean
-    attribute :position,            Integer
-    attribute :required,            Boolean
-    attribute :dictionaryMetadataUuid, String
+    attribute :meta, Meta
+    attribute :id, String
+    attribute :name, String
+    attribute :type, String # string, customentity
+    attribute :required, Boolean
+    attribute :customEntityMeta, Meta
 
     def is_dictionary?
-      attrType == 'ID_CUSTOM'
-    end
-
-    # Если это свойство типа ID_CUSTOM, то возвращается пользовательский справочник
-    #
-    # @return Moysklad::Entities::CustomEntityMetadata
-    def dictionatyMetadata universe
-      raise "Это свойства не типа справочник" unless dictionaryMetadataUuid
-      universe.custom_entity_metadata.find dictionaryMetadataUuid
+      type == 'customentity'
     end
-
-    # Справочник к которому принадлежит это ссвойство
-    #
-    # @return Moysklad::Entities::EmbeddedEntityMetadata
-    def entityMetadata universe
-      universe.embedded_entity_metadata.find entityMetadataUuid
-    end
-
   end
 end

data/lib/moysklad/entities/attribute_value.rb

@@ -0,0 +1,18 @@
+module Moysklad::Entities
+  class AttributeValue < Virtus::Attribute
+    def coerce(value)
+      case value
+      when String, Float
+        value
+      when ::Hash
+        if value['meta']['type'] == 'customentity'
+          CustomEntity.new value
+        else
+          raise "Unknown meta type: #{value['meta']['type']}"
+        end
+      else
+        raise "Unknown value type (#{value}) #{value.class}"
+      end
+    end
+  end
+end

data/lib/moysklad/entities/base.rb

@@ -1,16 +1,31 @@
 module Moysklad::Entities
   class Base
-    #include Object
+    include Virtus.model
+    attr_accessor :universe
+    attr_accessor :dump
 
-    private
+    def self.build(data, universe)
+      entity = new data
+      entity.universe = universe
+      entity
+    end
+
+    def initialize(data = {})
+      data['attrs'] = data.delete 'attributes' if data['attributes']
+      super (data || {}).merge(dump: data)
+    end
 
-    def cache ns, key
-      @cache||={}
-      @cache[ns]||={}
-      cc = @cache[ns]
+    def to_json(*args)
+      presented = {}
+      to_h.each_pair do |k, v|
+        presented[k] = v unless v.nil?
+      end
+
+      presented.to_json
+    end
 
-      cc[key] = yield unless cc.has_key? key
-      cc[key]
+    def to_s
+      attributes.to_s
     end
   end
 end

data/lib/moysklad/entities/bundle.rb

@@ -0,0 +1,39 @@
+module Moysklad::Entities
+  # Комплект
+  # https://online.moysklad.ru/api/remap/1.1/doc/index.html#комплект
+  class Bundle < Product
+    #meta - Метаданные объекта
+    #id - ID Комплекта в формате UUID Только для чтения
+    #accountId - ID учетной записи Только для чтения
+    #owner - Ссылка на Владельца (Сотрудника) в формате Метаданных
+    #shared - Общий доступ
+    #group - Отдел сотрудника в формате Метаданных
+    #syncId - ID синхронизации Только для чтения
+    #version - Версия сущности Только для чтения
+    #updated - Момент последнего обновления сущности Только для чтения
+    #name - Наименование Комплекта Необходимое
+    #description - Описание Комплекта
+    #code - Код Комплекта
+    #externalCode - Внешний код Комплекта
+    #archived - Отметка о том, добавлен ли Комплект в архив
+    #pathName - Наименование группы, в которую входит Комплект Только для чтения
+    #vat - НДС %
+      #effectiveVat - Реальный НДС % Только для чтения
+    #productFolder - Ссылка на группу Комплекта
+    #uom - Единицы измерения
+    #image - Изображение Комплекта Только для чтения
+    #minPrice - Минимальная цена
+    #salePrices - Цены продажи
+    #attributes - Коллекция доп. полей в формате Метаданных
+    #country - Ссылка на страну в формате Метаданных
+    #article - Артикул
+    #weight - Вес
+    #volume - Объём
+    #barcodes - Массив штрихкодов Комплекта
+    #overhead - Дополнительные расходы
+    #currency - Валюта доп расходов
+    #value - Значение доп расходов
+    #components - Компоненты Комплекта
+
+  end
+end

data/lib/moysklad/entities/characteristic.rb

@@ -0,0 +1,4 @@
+module Moysklad::Entities
+  class Characteristic < Attribute
+  end
+end

data/lib/moysklad/entities/characteristic_metadata.rb

@@ -0,0 +1,4 @@
+module Moysklad::Entities
+  class CharacteristicMetadata < AttributeMetadata
+  end
+end