moy_sklad 1.0.0.beta1

data/doc/xml/PaymentIn.xml

@@ -0,0 +1,81 @@
+<?xml version="1.0"?>
+<paymentIn readMode="NONE" changeMode="NEIGHBOUR" updated="2013-11-23T15:44:07" updatedBy="string" name="string" stateUuid="string" targetAgentUuid="string" sourceAgentUuid="string" targetStoreUuid="string" sourceStoreUuid="string" applicable="true" projectUuid="string" contractUuid="string" moment="2006-08-19T19:27:14+02:00" targetAccountUuid="string" sourceAccountUuid="string" payerVat="false" retailStoreUuid="string" currencyUuid="string" rate="1.051732E7" vatIncluded="true" created="2017-05-15T08:41:13" createdBy="string" employeeUuid="string" expenseItemUuid="string" incomingDate="2013-12-21T12:32:42+01:00" incomingNumber="string" paymentPurpose="string" vatSum="1.051732E7" commissionReportUuid="string" customerOrderUuid="string" factureOutUuid="string" invoiceOutUuid="string" purchaseReturnUuid="string">
+  <!--Optional:-->
+  <accountUuid>string</accountUuid>
+  <!--Optional:-->
+  <accountId>string</accountId>
+  <!--Optional:-->
+  <uuid>string</uuid>
+  <!--Optional:-->
+  <groupUuid>string</groupUuid>
+  <!--Optional:-->
+  <deleted>2016-01-01T20:07:42</deleted>
+  <!--Optional:-->
+  <code>string</code>
+  <!--Optional:-->
+  <externalcode>string</externalcode>
+  <!--Optional:-->
+  <description>string</description>
+  <!--Zero or more repetitions:-->
+  <attribute readMode="SELF" changeMode="PARENT" updated="2019-08-19T16:35:10" updatedBy="string" metadataUuid="string" valueText="string" valueString="string" doubleValue="1.051732E7" longValue="10" booleanValue="true" timeValue="2013-06-17T19:14:58" entityValueUuid="string" agentValueUuid="string" goodValueUuid="string" placeValueUuid="string" consignmentValueUuid="string" contractValueUuid="string" projectValueUuid="string" employeeValueUuid="string" operationUuid="string">
+    <!--Optional:-->
+    <accountUuid>string</accountUuid>
+    <!--Optional:-->
+    <accountId>string</accountId>
+    <!--Optional:-->
+    <uuid>string</uuid>
+    <!--Optional:-->
+    <groupUuid>string</groupUuid>
+    <!--Optional:-->
+    <deleted>2005-09-12T10:55:02+02:00</deleted>
+    <!--Optional:-->
+    <file readMode="NONE" changeMode="SELF" updated="2015-08-24T01:09:23" updatedBy="string" name="string" created="2015-06-18T00:07:00+02:00" filename="string" miniatureUuid="string">
+      <!--Optional:-->
+      <accountUuid>string</accountUuid>
+      <!--Optional:-->
+      <accountId>string</accountId>
+      <!--Optional:-->
+      <uuid>string</uuid>
+      <!--Optional:-->
+      <groupUuid>string</groupUuid>
+      <!--Optional:-->
+      <deleted>2000-04-21T02:36:55+02:00</deleted>
+      <!--Optional:-->
+      <code>string</code>
+      <!--Optional:-->
+      <externalcode>string</externalcode>
+      <!--Optional:-->
+      <description>string</description>
+      <!--Optional:-->
+      <contents>cXVpc3F1YW0=</contents>
+    </file>
+  </attribute>
+  <!--Zero or more repetitions:-->
+  <document readMode="PARENT" changeMode="PARENT" updated="2008-08-06T16:17:00+02:00" updatedBy="string" name="string" created="2011-12-25T03:49:17" filename="string" miniatureUuid="string" emailedDate="2015-10-10T12:07:56+02:00" publicId="string" operationUuid="string">
+    <!--Optional:-->
+    <accountUuid>string</accountUuid>
+    <!--Optional:-->
+    <accountId>string</accountId>
+    <!--Optional:-->
+    <uuid>string</uuid>
+    <!--Optional:-->
+    <groupUuid>string</groupUuid>
+    <!--Optional:-->
+    <deleted>2018-07-19T10:02:25+02:00</deleted>
+    <!--Optional:-->
+    <code>string</code>
+    <!--Optional:-->
+    <externalcode>string</externalcode>
+    <!--Optional:-->
+    <description>string</description>
+    <!--Optional:-->
+    <contents>YmVsbGE=</contents>
+  </document>
+  <!--Optional:-->
+  <sum sum="1.051732E7" sumInCurrency="1.051732E7"/>
+  <!--Optional:-->
+  <demandsUuid>
+    <!--Zero or more repetitions:-->
+    <demandRef>string</demandRef>
+  </demandsUuid>
+</paymentIn>

data/doc/xml/README.md

@@ -0,0 +1 @@
+Все xml'ки созданы из MOYSklad.xsd при помощи: http://devutilsonline.com/xsd-xml/generate-xml-from-xsd

data/lib/moy_sklad/client/attribute.rb

@@ -0,0 +1,119 @@
+# Placeholder class used by Nokogiri for create "clean" xml
+# requests.
+require 'active_support/core_ext/hash/indifferent_access'
+
+module MoySklad::Client
+  module Attribute
+    class MissingAttr
+      def method_missing(meth, *args)
+        MissingAttr.new
+      end
+
+      def empty?
+        true
+      end
+    end
+  end
+
+  # Include in baseclass because we need this in ALL subclasses
+  # (also in autocreated by AR)
+  module MissingAttrHandler
+    def method_missing(meth, *args)
+      if meth[-1] != '='
+        begin
+          super
+        rescue
+          MoySklad::Client::Attribute::MissingAttr.new
+        end
+      else
+        super
+      end
+    end
+  end
+
+  module CustomAttrBehavior
+
+    # Attributes array is widely used in all MS data objects. It handle custom attributes
+    # for each object. For make life easier we're use get/set_attribute functions.
+
+    # Get attrubute from the "attributes" array of the object.
+    #
+    # @attr info  [Hash] attribute info hash, should have keys: {:uuid, :value}
+    # @attr value [Object] value to set
+    #
+    def set_attribute(info, value)
+
+      fail ArgumentError, "Argument should be hash with at least [:uuid, :value] keys" unless info.is_a?(Hash)
+
+      info = HashWithIndifferentAccess.new(info)
+      fail ArgumentError, "You must provide keys: [:uuid, :value]" unless info.has_key?(:uuid) || info.has_key?(:value)
+
+      v = find_object(:attribute, :metadataUuid, info[:uuid])
+      if v.nil?
+        data = { metadataUuid: info[:uuid] }
+        data[info[:value]] = value
+        a = create_and_load_resource('Attribute', data)
+        if self.to_a(:attribute).empty?
+          self.attribute = [a]
+        else
+          self.attribute << a
+        end
+      else
+        v.send("#{info[:value]}=".to_sym, value)
+      end
+
+    end
+
+    # Set attribute in "attributes" array of the object.
+    #
+    # @attr info [Hash/String] hash with at least [:uuid] key or String with uuid.
+    #                          if hash containts [:value] key then value will be returned
+    #                          instead of plceholder object.
+    def get_attribute(info)
+
+      uuid = info if info.is_a?(String) && (info.length == 36)
+
+      if info.is_a?(Hash)
+        info = HashWithIndifferentAccess.new(info)
+        uuid = info[:uuid] if info.is_a?(Hash) && (!info[:uuid].nil? && info[:uuid].length == 36)
+      end
+
+      fail ArgumentError, "Argument should be uuid string or hash with [:uuid] key" if uuid.nil?
+
+      a = find_object(:attribute, :metadataUuid, uuid)
+
+      if info.is_a?(Hash) && info.has_key?(:value)
+        return a.send(info[:value]) if a.respond_to?(info[:value])
+        nil
+      else
+        a
+      end
+    end
+
+    # Get object attribute as array.
+    # object.to_a(:some_type) will always return array and of course it can be empty.
+    def to_a(type)
+
+      value = self.send(type)
+      return [] if value.nil? || value.is_a?(MoySklad::Client::Attribute::MissingAttr)
+
+      # Convert
+      self.send("#{type}=", [value]) unless value.is_a?(Array)
+      self.send(type)
+    end
+
+    # Check is nested resource empty or not
+    def empty?
+      attributes.empty?
+    end
+
+    # Remove attribute from object
+    def remove_attr(attribute)
+      attributes.delete(attribute)
+      known_attributes.delete(attribute)
+    end
+  end
+
+  ActiveResource::Base.send(:include, MissingAttrHandler)
+  ActiveResource::Base.send(:include, CustomAttrBehavior)
+end

data/lib/moy_sklad/client/base.rb

@@ -0,0 +1,112 @@
+# ActiveResource base class
+# All models shoud extend this class
+
+module MoySklad::Client
+  class Base < ActiveResource::Base
+    self.site = MoySklad.configuration.base_url
+    self.format = Formatter.new
+    self.user = MoySklad.configuration.user_name
+    self.password = MoySklad.configuration.password
+    self.auth_type = :basic
+
+    if ActiveResource::VERSION::STRING >= '4.0.0'
+      self.include_format_in_path = false
+      self.collection_parser = Collection
+    end
+
+    @@template_path = File.join(File.dirname(__FILE__), '..', 'model', 'templates')
+
+    class << self
+
+      def find(*args)
+        # Little trick for correct baseclass name
+        self.format.element_name = element_name.classify
+        super(*args)
+      end
+
+      # Custom path builder
+      def element_path(id, prefix_options = {}, query_options = nil)
+        check_prefix_options(prefix_options)
+
+        prefix_options, query_options = split_options(prefix_options) if query_options.nil?
+        "#{prefix(prefix_options)}#{element_name.classify}/" \
+        "#{URI.parser.escape id.to_s}#{query_string(query_options)}"
+      end
+
+      def new_element_path(prefix_options = {})
+        "#{prefix(prefix_options)}#{element_name.classify}"
+      end
+
+      def collection_name
+        @collection_name ||= "#{element_name.classify}/list"
+      end
+
+      if ActiveResource::VERSION::STRING < '4.0.0'
+        def collection_path(prefix_options = {}, query_options = nil)
+          check_prefix_options(prefix_options)
+          prefix_options, query_options = split_options(prefix_options) if query_options.nil?
+          "#{prefix(prefix_options)}#{collection_name}#{query_string(query_options)}"
+        end
+      end
+    end
+
+    # Override create method, this required because moysklad uses PUT instead of POST
+    if ActiveResource::VERSION::STRING < '4.0.0'
+      def create
+        _create
+      end
+
+      def destroy
+        _destroy
+      end
+    else
+      def create
+        run_callbacks :create do _create end
+      end
+
+      def destroy
+        run_callbacks :destroy do _destroy end
+      end
+    end
+
+    def save
+      super
+      self.error.is_a?(MoySklad::Client::Attribute::MissingAttr)
+    end
+
+    private
+
+    def _create
+      connection.put(new_element_path, encode, self.class.headers).tap do |response|
+        self.id = id_from_response(response)
+        load_attributes_from_response(response)
+      end
+    end
+
+    def _destroy
+      connection.delete(self.class.element_path(uuid), self.class.headers)
+    end
+
+    # Custom data encoder
+    # Template compiled only ONCE !!!
+    def encode
+      compile_template unless respond_to?(:create_xml)
+      create_xml
+    end
+
+    def compile_template
+      file_path = File.join("#{@@template_path}", "#{self.class.element_name}.builder")
+      File.open(file_path) do |f|
+        template = f.read
+
+        self.class.module_eval(<<-CODE)
+          def create_xml
+            builder = ::Nokogiri::XML::Builder.new(encoding: 'utf-8') do |xml|
+              #{template}
+            end.to_xml()
+          end
+        CODE
+      end
+    end
+  end
+end

data/lib/moy_sklad/client/collection.rb

@@ -0,0 +1,52 @@
+# Resources collection handler
+
+require 'active_resource'
+require 'active_support/core_ext/hash/conversions'
+require 'active_support/core_ext/hash/indifferent_access'
+
+module MoySklad::Client
+  if ActiveResource::VERSION::STRING < '4.0.0'
+    class Collection
+      include Enumerable
+
+      delegate :collect, :each, :length, :to => :to_a
+
+      attr_accessor :elements
+
+      def to_a
+        @elements
+      end
+
+      def collect!
+        return @elements unless block_given?
+        set = []
+        each { |o| set << yield(o) }
+        @elements = set
+        self
+      end
+
+      alias map! collect!
+    end
+  else
+    class Collection < ActiveResource::Collection
+    end
+  end
+
+  class Collection
+    attr_reader :metadata
+
+    def initialize(data)
+
+      @elements = data[:data]['collection'].delete(data[:object])
+      @elements = [@elements] if @elements.is_a?(Hash)
+      @metadata = HashWithIndifferentAccess.new(data[:data]['collection'])
+
+      @elements ||= []
+
+      # Fix keys
+      [:total, :start, :count].each do |k|
+        @metadata[k] = @metadata[k].to_i if @metadata.has_key?(k)
+      end
+    end
+  end
+end

data/lib/moy_sklad/client/formatter.rb

@@ -0,0 +1,37 @@
+# Custom formatter
+# Used only on retrive process. Submission encoder live in base.rb
+
+require 'active_resource'
+require 'active_support/core_ext/hash/conversions'
+
+module MoySklad::Client
+  class Formatter
+    include ::ActiveResource::Formats::XmlFormat
+
+    attr_accessor :element_name
+
+    def decode(_data)
+      data = Hash.from_xml(_data)
+
+      if data.has_key?('collection')
+        collection(data)
+      else
+        {data.keys.first.underscore => data.values.first}
+      end
+    end
+
+    def _data(data)
+      { data: data, object: element_name[0].downcase + element_name[1..-1] }
+    end
+
+    if ActiveResource::VERSION::STRING < '4.0.0'
+      def collection(data)
+        MoySklad::Client::Collection.new(_data(data))
+      end
+    else
+      def collection(data)
+        _data(data)
+      end
+    end
+  end
+end

data/lib/moy_sklad/client/resource.rb

@@ -0,0 +1,56 @@
+# Nested resources management
+
+module ActiveResource
+  class Base
+
+    # Nested object finder by type uuid + object uuid.
+    #
+    # MS data model have arrays which contains objects where each object have a special "type"
+    # uuid and object uuid. Type + Object uuids are PK for the object.
+    #
+    # @attr name [Symbol] attribute name
+    # @attr type [String] "type" uuid
+    # @attr key  [String] "object" uuid
+    #
+    def find_object(name, type, key)
+      return nil if self.send(name).is_a?(MoySklad::Client::Attribute::MissingAttr)
+
+      create_nested_resource(name)
+
+      # Convert single attr to array
+      self.send("#{name}=", [self.send(name)]) unless self.send(name).is_a?(Array)
+
+      self.send(name).each do |v|
+        return v if v.send(type) == key
+      end
+
+      nil
+    end
+
+    private
+
+    # Construct nested resource class and load with given attributes
+    # NB: ALL nested classes should be created through this way.
+    def create_and_load_resource(name, attributes = nil)
+      res = find_or_create_resource_for(name).new
+      res.load(attributes) if !attributes.nil?
+      res
+    end
+
+    def create_nested_collection(name)
+      create_nested_collection_or_resource(name)
+    end
+
+    def create_nested_resource(name)
+      create_nested_collection_or_resource(name, false)
+    end
+
+    def create_nested_collection_or_resource(name, collection = true)
+      name = name.to_s
+      if !known_attributes.include?(name) || attributes[name].nil?
+        known_attributes << name
+        attributes[name] = collection ? [] : create_and_load_resource(name)
+      end
+    end
+  end
+end

data/lib/moy_sklad/client.rb

@@ -0,0 +1,5 @@
+require 'moy_sklad/client/formatter'
+require 'moy_sklad/client/collection'
+require 'moy_sklad/client/attribute'
+require 'moy_sklad/client/resource'
+require 'moy_sklad/client/base'

data/lib/moy_sklad/configuration.rb

@@ -0,0 +1,74 @@
+module MoySklad
+  # Returns the global [Configuration](MoySklad/Configuration) object. While you
+  # _can_ use this method to access the configuration, the more common
+  # convention is to use [MoySklad.configure](MoySklad#configure-class_method).
+  #
+  # @example
+  #     MoySklad.configuration.user_name = 'admin@example'
+  # @see MoySklad.configure
+  # @see Configuration
+  def self.configuration
+    @configuration ||= MoySklad::Configuration.new
+  end
+
+  # Yields the global configuration to a block.
+  # @yield [Configuration] global configuration
+  #
+  # @example
+  #     MoySklad.configure do |config|
+  #       config.user_name 'admin@example'
+  #       config.password '1234567890'
+  #     end
+  # @see Configuration
+  def self.configure
+    yield configuration if block_given?
+  end
+
+  # Stores runtime configuration information.
+  #
+  # @example
+  #     MoySklad.configure do |config|
+  #       config.user_name 'admin@example'
+  #       config.password '1234567890'
+  #     end
+  #
+  # @see MoySklad.configure
+  class Configuration
+    # User name for authentication.
+    # @attr value [String] defaults to `''`
+    attr_reader :user_name
+
+    def user_name=(v)
+      MoySklad::Client::Base.user = @user_name = v
+    end
+
+    # Password for authentication.
+    # @attr value [String] defaults to `''`
+    attr_reader :password
+
+    def password=(v)
+      MoySklad::Client::Base.password = @password = v
+    end
+
+    # Base url.
+    # @attr value [String] defaults to
+    # `'https://online.moysklad.ru/exchange/rest/ms/xml'`
+    attr_reader :base_url
+
+    def base_url=(v)
+      MoySklad::Client::Base.site = @base_url = v
+    end
+
+    # Currency UUID.
+    # @attr value [String] defaults to
+    # `'131bf5ff-1ee5-11e4-67ed-002590a28eca'`
+    attr_accessor :currency
+
+    def initialize
+      @user_name = ''
+      @password = ''
+      @base_url = 'https://online.moysklad.ru/exchange/rest/ms/xml'
+      @currency = '131bf5ff-1ee5-11e4-67ed-002590a28eca'
+    end
+  end
+end

data/lib/moy_sklad/model/company.rb

@@ -0,0 +1,23 @@
+module MoySklad::Model
+  class Company < MoySklad::Client::Base
+    def initialize(*args)
+      super(*args)
+
+      create_nested_resource(:contact)
+      create_nested_resource(:requisite)
+      create_nested_resource(:tags)
+      create_nested_collection(:contactPerson)
+      requisite.create_nested_resource(:bankAccount)
+    end
+
+    def add_contact(options)
+
+      # We're always have one person
+      if to_a(:contactPerson).empty?
+        contactPerson << create_and_load_resource('contactPerson', options)
+      else
+        to_a(:contactPerson)[0].load(options)
+      end
+    end
+  end
+end

data/lib/moy_sklad/model/country.rb

@@ -0,0 +1,12 @@
+require 'yaml'
+
+module MoySklad::Model
+  class Country < MoySklad::Client::Base
+    class << self
+      def uuid_from_code(code)
+        @_country_cache ||= YAML.load_file(File.join(File.dirname(__FILE__), 'data', 'country_codes.yml'))
+        @_country_cache[code.to_s]
+      end
+    end
+  end
+end

data/lib/moy_sklad/model/custom_entity.rb

@@ -0,0 +1,4 @@
+module MoySklad::Model
+  class CustomEntity < MoySklad::Client::Base
+  end
+end

data/lib/moy_sklad/model/customer_order.rb

@@ -0,0 +1,21 @@
+module MoySklad::Model
+  class CustomerOrder < MoySklad::Client::Base
+
+    def initialize(*args)
+      super(*args)
+      create_nested_collection(:customerOrderPosition)
+      create_nested_collection(:attribute)
+      create_nested_resource(:sum)
+    end
+
+    def add_item(id, options = {})
+      item = create_and_load_resource("CustomerOrderPosition",
+                                      { goodUuid: id }.merge!(options))
+      if to_a(:customerOrderPosition).empty?
+        self.customerOrderPosition = [item]
+      else
+        self.customerOrderPosition << item
+      end
+    end
+  end
+end