retailcrm-api 0.0.2 → 0.0.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a899837cb8ddb00dc0f7fdfbb499c7d9aaf1aee6efc60832b518cf0c5c166b44
-  data.tar.gz: 0f59cfab3576315c86e6e9ddbe5276dd95a320f1ecf298462d832d09f95d9cec
+  metadata.gz: 19aca33fa8aabb3a4cd9acffaa7ed004cbd8be0a126ddb8f4c93b162fb60c50a
+  data.tar.gz: ea0d5c405d9c6073044a028eea147c207a0bc7ccbb784b02ddd6d6b108e40661
 SHA512:
-  metadata.gz: acf05919e79a85406722c780382382d92e70a6f51f6aaf832f8cc09dfe0cbe8bdb2e62d1eec8844c94cd3a1664092c9e8baddf9d2a5e99e69d0808e290c2651b
-  data.tar.gz: edc3606cd9b6968dadb9fe9ab40069327f6a050dc584c9d34bd984dea718dc0d6d4526e2c81045585169ee03d70e5b980626d991e332d849a063cbcf21fa16f9
+  metadata.gz: a10e4ac6b8700f48597a3585a9a0cf5ef2aa646fedddec463fa02c7573f4c1b877335e2bbf6d8e99a76ae10675b4a0c00f858f050d924689774f732f9e45d3f8
+  data.tar.gz: 953ae085065c09ab797cef8bdd66cc4465500e43617d8ff1816305ec54755e63f2b47a55a2629eab5fca597d4ad3c200f07bbb2113d9b1418b8514b6ed296568

data/README.markdown

@@ -2,7 +2,7 @@
 
 API wrapper для RetailCRM
 
-# Установка Ruby
+# Установка
 
 ## Ruby
     $ gem install retailcrm-api
@@ -70,20 +70,105 @@ RetailcrmApi::Request.logger = MyLogger.new
 
 ### [Получение списка расходов, удовлетворяющих заданному фильтру](https://docs.retailcrm.ru/Developers/API/APIVersions/APIv5#get--api-v5-costs)
 ```ruby
-RetailcrmApi::Request.costs.retrieve.body
+params = {
+  filter: {
+    minSumm: 0
+  }
+}
+RetailcrmApi::Request.costs.retrieve(params: params).body
 # => {:success=>true, :pagination=>{:limit=>20, :totalCount=>296, :currentPage=>1, :totalPageCount=>15}, :costs=>[{:id=>296, :dateFrom=>"2021-07-29", :dateTo=>"2021-07-29", :summ=>13996, :costItem=>"products-purchase-price", :createdAt=>"2021-07-29 00:34:35", :order=>{:id=>36, :number=>"36C"}, :sites=>["b12-skillum-ru"]}]}
 ```
+### [Создание расхода](https://docs.retailcrm.ru/Developers/API/APIVersions/APIv5#post--api-v5-costs-create)
+```ruby
+body = {
+  site: "deppa-ru",
+  cost: {
+    summ: 100,
+    costItem: "office-expenses",
+    dateFrom: (DateTime.now - 1.day).strftime("%Y-%m-%d"),
+    dateTo: DateTime.now.strftime("%Y-%m-%d")
+  }
+}
+RetailcrmApi::Request.costs.create(body: body).body
+# => {:success=>true, :id=>297}
+```
+### [Пакетное удаление расходов](https://docs.retailcrm.ru/Developers/APIhttps://docs.retailcrm.ru/Developers/API/APIVersions/APIv5#post--api-v5-costs-delete)
+```ruby
+body = {
+  ids: [297]
+}
+RetailcrmApi::Request.costs.create(body: body, suffix: "delete").body
+# => {:success=>true, :count=>1, :notRemovedIds=>[]}
+```
+### [Пакетная загрузка расходов](https://docs.retailcrm.ru/Developers/API/APIVersions/APIv5#post--api-v5-costs-upload)
+```ruby
+body = {
+  costs: [
+    {
+      sites: ["deppa-ru"],
+      summ: 100,
+      costItem: "office-expenses",
+      dateFrom: (DateTime.now - 1.day).strftime("%Y-%m-%d"),
+      dateTo: DateTime.now.strftime("%Y-%m-%d")
+    }
+  ]
+}
+RetailcrmApi::Request.costs.create(body: body, suffix: "upload").body
+# => {:success=>true, :uploadedCosts=>[298]}
+```
+### [Получение информации о расходе](https://docs.retailcrm.ru/Developers/API/APIVersions/APIv5#get--api-v5-costs-id)
+```ruby
+RetailcrmApi::Request.costs(298).retrieve.body
+# => {:success=>true, :cost=>{:id=>298, :dateFrom=>"2021-08-02", :dateTo=>"2021-08-03", :summ=>100, :costItem=>"office-expenses", :createdAt=>"2021-08-03 22:12:34", :sites=>["deppa-ru"]}} 
+```
+### [Редактирование расхода](https://docs.retailcrm.ru/Developers/API/APIVersions/APIv5#post--api-v5-costs-id-edit)
+```ruby
+body = {
+  site: "deppa-ru",
+  cost: {
+    summ: 200,
+    costItem: "office-expenses",
+    dateFrom: (DateTime.now - 1.day).strftime("%Y-%m-%d"),
+    dateTo: DateTime.now.strftime("%Y-%m-%d")
+  }
+}
+RetailcrmApi::Request.costs(298).update(body: body).body
+# => {:success=>true, :id=>298}
+```
+### [Удаление расхода](https://docs.retailcrm.ru/Developers/API/APIVersions/APIv5#post--api-v5-costs-id-delete)
+```ruby
+RetailcrmApi::Request.costs(298).delete.body
+# => {:success=>true}
+```
+
+## Пользовательские поля
+### [Получение списка пользовательских полей, удовлетворяющих заданному фильтру](https://docs.retailcrm.ru/Developers/API/APIVersions/APIv5#get--api-v5-custom-fields)
+```ruby
+params = {
+  filter: {
+    type: "date"
+  }
+}
+RetailcrmApi::Request.custom_fields.retrieve(params: params).body
+# =>{:success=>true, :pagination=>{:limit=>20, :totalCount=>0, :currentPage=>1, :totalPageCount=>0}, :customFields=>[]}
+```
 
 ## Клиенты
 ### [Получение списка клиентов, удовлетворяющих заданному фильтру](https://docs.retailcrm.ru/Developers/API/APIVersions/APIv5#get--api-v5-customers)
 ```ruby
-RetailcrmApi::Request.customers.retrieve.body
-#=> {:success=>true, :pagination=>{:limit=>20, :totalCount=>0, :currentPage=>1, :totalPageCount=>0}, :customers=>[]} 
+params = {
+  limit: 100,
+  filter: {
+    sex: "male"
+  }
+}
+RetailcrmApi::Request.customers.retrieve(params: params).body
+#=> {:success=>true, :pagination=>{:limit=>100, :totalCount=>0, :currentPage=>1, :totalPageCount=>0}, :customers=>[]} 
 ```
 ### [Создание клиента](https://docs.retailcrm.ru/Developers/API/APIVersions/APIv5#post--api-v5-customers-create)
 ```ruby
 body = {
-  site: 'deppa',
+  site: 'deppa-ru',
   customer: {
     externalId: 1,
     firstName: 'Павел',
@@ -92,4 +177,47 @@ body = {
 }
 RetailcrmApi::Request.customers.create(body: body).body
 #=> {:success=>true, :id=>54}
+```
+### [Пакетная загрузка клиентов](https://docs.retailcrm.ru/Developers/API/APIVersions/APIv5#post--api-v5-customers-upload)
+```ruby
+body = {
+  site: 'deppa-ru',
+  customers: [
+    {
+      externalId: 3,
+      firstName: 'Имя',
+      lastName: 'Фамилия'
+    },
+    {
+      externalId: 4,
+      firstName: 'Имя2',
+      lastName: 'Фамилия2'
+    }
+  ]
+}
+RetailcrmApi::Request.customers.create(body: body, suffix: "upload").body
+```
+
+## Корпоративные клиенты
+### [Получение списка корпоративных клиентов, удовлетворяющих заданному фильтру](https://docs.retailcrm.ru/Developers/API/APIVersions/APIv5#get--api-v5-customers-corporate)
+```ruby
+RetailcrmApi::Request.customers_corporate.retrieve.body
+# => {:success=>true, :pagination=>{:limit=>20, :totalCount=>0, :currentPage=>1, :totalPageCount=>0}, :customersCorporate=>[]} 
+```
+
+### [Пакетная загрузка корпоративных клиентов](https://docs.retailcrm.ru/Developers/API/APIVersions/APIv5#post--api-v5-customers-corporate-upload)
+```ruby
+body = {
+  site: 'deppa-ru"',
+  customersCorporate: [
+    {
+      externalId: 3,
+      nickName: 'test1'
+    },
+    {
+      externalId: 4,
+      nickName: 'test2'
+    }
+  ]
+}
 ```

data/lib/retailcrm-api/api_request.rb

@@ -9,11 +9,16 @@ module RetailcrmApi
       validate_api_key
       begin
         response = self.rest_client(suffix).post do |request|
-          configure_request(request: request, params: params, headers: headers, body: MultiJson.dump(body))
+          configure_request(request: request, params: params, headers: headers, body: body)
         end
         parse_response(response)
       rescue => e
-        handle_error(e)
+        if e.response.dig(:status) == 403 && first_time
+          sleep(0.3.second)
+          self.post(params: params, headers: headers, suffix: suffix, body: body, first_time: false)
+        else
+          handle_error(e)
+        end
       end
     end
 
@@ -26,7 +31,12 @@ module RetailcrmApi
         end
         parse_response(response)
       rescue => e
-        handle_error(e)
+        if e.response.dig(:status) == 403 && first_time
+          sleep(0.3.second)
+          self.get(params: params, headers: headers, first_time: false)
+        else
+          handle_error(e)
+        end
       end
     end
 
@@ -96,11 +106,14 @@ module RetailcrmApi
     def configure_request(request: nil, params: nil, headers: nil, body: nil)
       if request
         request.params.merge!(params) if params
-        request.headers['Content-Type'] = 'application/json'
+        request.headers['Content-Type'] = 'application/x-www-form-urlencoded'
         request.headers['X-API-KEY'] = "#{self.api_key}"
         request.headers['User-Agent'] = "RetailCrmApi/#{RetailcrmApi::VERSION} Ruby gem"
         request.headers.merge!(headers) if headers
-        request.body = body if body
+        if body
+          body.each { |k, v| body[k] = MultiJson.dump(v) }
+          request.body = URI.encode_www_form(body)
+        end
         request.options.timeout = self.timeout
         request.options.open_timeout = self.open_timeout
       end

data/lib/retailcrm-api/request.rb

@@ -6,8 +6,6 @@ module RetailcrmApi
     DEFAULT_OPEN_TIMEOUT = 60
 
     def initialize(api_key: nil, api_endpoint: nil, timeout: nil, open_timeout: nil, proxy: nil, faraday_adapter: nil, symbolize_keys: false, debug: false, logger: nil, test: false)
-      p "Request initialize #{api_key}"
-
       @path_parts = []
       @api_key = api_key || self.class.api_key || ENV['RETAILCRM_API_KEY']
       @api_key = @api_key.strip if @api_key
@@ -25,7 +23,7 @@ module RetailcrmApi
     end
 
     def method_missing(method, *args)
-      @path_parts << method.to_s.downcase
+      @path_parts << method.to_s.gsub("_", "-").downcase
       @path_parts << args if args.length > 0
       @path_parts.flatten!
       self
@@ -47,14 +45,14 @@ module RetailcrmApi
       @path_parts.join('/')
     end
 
-    def create(params: nil, headers: nil, body: {})
-      APIRequest.new(builder: self).post(params: params, headers: headers, suffix: 'create', body: body)
+    def create(params: nil, headers: nil, body: {}, suffix: 'create')
+      APIRequest.new(builder: self).post(params: params, headers: headers, suffix: suffix, body: body)
     ensure
       reset
     end
 
     def update(params: nil, headers: nil, body: {})
-      APIRequest.new(builder: self).post(params: params, headers: headers, suffix: 'update', body: body)
+      APIRequest.new(builder: self).post(params: params, headers: headers, suffix: 'edit', body: body)
     ensure
       reset
     end
@@ -65,8 +63,8 @@ module RetailcrmApi
       reset
     end
 
-    def delete(params: nil, headers: nil, suffix: 'delete')
-      APIRequest.new(builder: self).post(params: params, headers: headers)
+    def delete(params: nil, headers: nil)
+      APIRequest.new(builder: self).post(params: params, headers: headers, suffix: 'delete')
     ensure
       reset
     end

data/lib/retailcrm-api/version.rb

@@ -1,3 +1,3 @@
 module RetailcrmApi
-  VERSION = "0.0.2"
+  VERSION = "0.0.6"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: retailcrm-api
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.6
 platform: ruby
 authors:
 - Pavel Osetrov
@@ -76,7 +76,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.22
+rubygems_version: 3.1.4
 signing_key:
 specification_version: 4
 summary: RetailCRM API