RetailCRM-Mirror/api-client-ruby
1
0
Fork 0
mirror of https://github.com/retailcrm/api-client-ruby.git synced 2024-11-22 04:56:06 +03:00
Code Issues Projects Releases Wiki Activity

fixes

Browse Source
This commit is contained in:
Alex Lushpai 2015-04-13 18:07:40 +03:00
parent 367c190b11
commit 9a16a5068f
4 changed files with 70 additions and 62 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
README.md
View File

@ -17,9 +17,9 @@ gem install retailcrm
```ruby ```ruby
require 'retailcrm' require 'retailcrm'
api = Retailcrm.new('https://yourcrmname.intarocrm.ru', 'yourApiKeyHere') api = Retailcrm.new('https://yourcrmname.retailcrm.ru', 'yourApiKeyHere')
response = api.orders_get(345, 'id').get_response response = api.orders_get(345, 'id').response
order = response[:order] order = response[:order]
``` ```
@ -64,12 +64,15 @@ order = {
] ]
} }
response = api.orders_create(order).get_response response = api.orders_create(order).response
order_id = response[:id] order_id = response[:id]
``` ```
#### REST API Documentation #### Документация REST API
http://www.retailcrm.ru/docs/Разработчики/СправочникМетодовAPIV3 http://www.retailcrm.ru/docs/Разработчики/СправочникМетодовAPIV3
#### Документация API библиотеки
http://www.rubydoc.info/gems/retailcrm

105
lib/retailcrm.rb
View File

@ -15,6 +15,10 @@ class Retailcrm
@rr_params = { :apiKey => @rr_key } @rr_params = { :apiKey => @rr_key }
end end
def self.up(params)
@rr_params = params
end
## ##
# === Get orders by filter # === Get orders by filter
# http://www.retailcrm.ru/docs/Разработчики/СправочникМетодовAPIV3 # http://www.retailcrm.ru/docs/Разработчики/СправочникМетодовAPIV3
@ -27,12 +31,12 @@ class Retailcrm
# limit (Integer) (20|50|100) # limit (Integer) (20|50|100)
# page (Integer) # page (Integer)
# filter (Array) # filter (Array)
def orders(filter = {}, limit = 20, page = 1) def orders(filter = nil, limit = 20, page = 1)
url = "#{@rr_url}orders" url = "#{@rr_url}orders"
@rr_params[:limit] = limit @rr_params[:limit] = limit
@rr_params[:page] = page @rr_params[:page] = page
@rr_params[:filter] = filter.to_json @rr_params[:filter] = filter
return make_request(url) make_request(url)
end end
## ##
@ -48,10 +52,10 @@ class Retailcrm
# by (String) # by (String)
def orders_get(id, by = 'externalId') def orders_get(id, by = 'externalId')
url = "#{@rr_url}orders/#{id}" url = "#{@rr_url}orders/#{id}"
if (by != 'externalId') if by != 'externalId'
@rr_params[:by] = by @rr_params[:by] = by
end end
return make_request(url) make_request(url)
end end
## ##
@ -67,7 +71,7 @@ class Retailcrm
def orders_create(order) def orders_create(order)
url = "#{@rr_url}orders/create" url = "#{@rr_url}orders/create"
@rr_params[:order] = order.to_json @rr_params[:order] = order.to_json
return make_request(url, 'post') make_request(url, 'post')
end end
## ##
@ -84,7 +88,7 @@ class Retailcrm
id = order[:externalId] id = order[:externalId]
url = "#{@rr_url}orders/#{id}/edit" url = "#{@rr_url}orders/#{id}/edit"
@rr_params[:order] = order.to_json @rr_params[:order] = order.to_json
return make_request(url, 'post') make_request(url, 'post')
end end
## ##
@ -100,8 +104,7 @@ class Retailcrm
def orders_upload(orders) def orders_upload(orders)
url = "#{@rr_url}orders/upload" url = "#{@rr_url}orders/upload"
@rr_params[:orders] = orders.to_json @rr_params[:orders] = orders.to_json
result = JSON.parse(make_request(url, 'post')) make_request(url, 'post')
return result[:uploadedOrders] || result
end end
## ##
@ -117,7 +120,7 @@ class Retailcrm
def orders_fix_external_ids(orders) def orders_fix_external_ids(orders)
url = "#{@rr_url}orders/fix-external-ids" url = "#{@rr_url}orders/fix-external-ids"
@rr_params[:orders] = orders.to_json @rr_params[:orders] = orders.to_json
return make_request(url, 'post') make_request(url, 'post')
end end
## ##
@ -129,17 +132,19 @@ class Retailcrm
# => {...} # => {...}
# #
# Arguments: # Arguments:
# startDate (Time) (Time.strftime('%Y-%m-%d %H:%M:%S')) # start_date (Time) (Time.strftime('%Y-%m-%d %H:%M:%S'))
# endDate (Time) (Time.strftime('%Y-%m-%d %H:%M:%S')) # end_date (Time) (Time.strftime('%Y-%m-%d %H:%M:%S'))
# limit (Integer) (20|50|100) # limit (Integer) (20|50|100)
# offset (Integer) # offset (Integer)
def orders_history(startDate = nil, endDate = nil, limit = 20, offset = 0) # skip_my_changes (Boolean)
def orders_history(start_date = nil, end_date = nil, limit = 100, offset = 0, skip_my_changes = true)
url = "#{@rr_url}orders/history" url = "#{@rr_url}orders/history"
@rr_params[:startDate] = startDate @rr_params[:startDate] = start_date
@rr_params[:endDate] = endDate @rr_params[:endDate] = end_date
@rr_params[:limit] = limit @rr_params[:limit] = limit
@rr_params[:offset] = offset @rr_params[:offset] = offset
return make_request(url) @rr_params[:skipMyChanges] = skip_my_changes
make_request(url)
end end
## ##
@ -154,7 +159,7 @@ class Retailcrm
# ids (Array) # ids (Array)
def orders_statuses(ids) def orders_statuses(ids)
url = "#{@rr_url}orders/statuses/#{ids}" url = "#{@rr_url}orders/statuses/#{ids}"
return make_request(url) make_request(url)
end end
## ##
@ -170,10 +175,10 @@ class Retailcrm
# by (String) # by (String)
def customers_get(id, by = 'externalId') def customers_get(id, by = 'externalId')
url = "#{@rr_url}customers/#{id}" url = "#{@rr_url}customers/#{id}"
if (by != 'externalId') if by != 'externalId'
@rr_params[:by] = by @rr_params[:by] = by
end end
return make_request(url) make_request(url)
end end
## ##
@ -189,7 +194,7 @@ class Retailcrm
def customers_create(customer) def customers_create(customer)
url = "#{@rr_url}customers/create" url = "#{@rr_url}customers/create"
@rr_params[:customer] = customer.to_json @rr_params[:customer] = customer.to_json
return make_request(url, 'post') make_request(url, 'post')
end end
## ##
@ -202,10 +207,11 @@ class Retailcrm
# #
# Arguments: # Arguments:
# customer (Array) # customer (Array)
def customers_edit(customer, id) def customers_edit(customer)
id = customer[:externalId]
url = "#{@rr_url}customers/#{id}/edit" url = "#{@rr_url}customers/#{id}/edit"
@rr_params[:customer] = customer.to_json @rr_params[:customer] = customer.to_json
return make_request(url, 'post') make_request(url, 'post')
end end
## ##
@ -221,8 +227,7 @@ class Retailcrm
def customers_upload(customers) def customers_upload(customers)
url = "#{@rr_url}customers/upload" url = "#{@rr_url}customers/upload"
@rr_params[:customers] = customers.to_json @rr_params[:customers] = customers.to_json
result = JSON.parse(make_request(url, 'post')) make_request(url, 'post')
return result[:uploaded] || result
end end
## ##
@ -238,7 +243,7 @@ class Retailcrm
def customers_fix_external_ids(customers) def customers_fix_external_ids(customers)
url = "#{@rr_url}customers/fix-external-ids" url = "#{@rr_url}customers/fix-external-ids"
@rr_params[:customers] = customers.to_json @rr_params[:customers] = customers.to_json
return make_request(url, 'post') make_request(url, 'post')
end end
## ##
@ -247,7 +252,7 @@ class Retailcrm
# #
def delivery_services def delivery_services
url = "#{@rr_url}reference/delivery-services" url = "#{@rr_url}reference/delivery-services"
return make_request(url) make_request(url)
end end
# Get delivery types # Get delivery types
@ -255,7 +260,7 @@ class Retailcrm
# #
def delivery_types def delivery_types
url = "#{@rr_url}reference/delivery-types" url = "#{@rr_url}reference/delivery-types"
return make_request(url) make_request(url)
end end
## ##
@ -264,7 +269,7 @@ class Retailcrm
# #
def order_methods def order_methods
url = "#{@rr_url}reference/order-methods" url = "#{@rr_url}reference/order-methods"
return make_request(url) make_request(url)
end end
## ##
@ -273,7 +278,7 @@ class Retailcrm
# #
def order_types def order_types
url = "#{@rr_url}reference/order-types" url = "#{@rr_url}reference/order-types"
return make_request(url) make_request(url)
end end
# Get payment statuses # Get payment statuses
@ -281,7 +286,7 @@ class Retailcrm
# #
def payment_statuses def payment_statuses
url = "#{@rr_url}reference/payment-statuses" url = "#{@rr_url}reference/payment-statuses"
return make_request(url) make_request(url)
end end
## ##
@ -290,7 +295,7 @@ class Retailcrm
# #
def payment_types def payment_types
url = "#{@rr_url}reference/payment-types" url = "#{@rr_url}reference/payment-types"
return make_request(url) make_request(url)
end end
## ##
@ -299,7 +304,7 @@ class Retailcrm
# #
def product_statuses def product_statuses
url = "#{@rr_url}reference/product-statuses" url = "#{@rr_url}reference/product-statuses"
return make_request(url) make_request(url)
end end
# Get sites list # Get sites list
@ -307,7 +312,7 @@ class Retailcrm
# #
def sites def sites
url = "#{@rr_url}reference/sites" url = "#{@rr_url}reference/sites"
return make_request(url) make_request(url)
end end
## ##
@ -316,7 +321,7 @@ class Retailcrm
# #
def status_groups def status_groups
url = "#{@rr_url}reference/status-groups" url = "#{@rr_url}reference/status-groups"
return make_request(url) make_request(url)
end end
# Get statuses # Get statuses
@ -324,7 +329,7 @@ class Retailcrm
# #
def statuses def statuses
url = "#{@rr_url}reference/statuses" url = "#{@rr_url}reference/statuses"
return make_request(url) make_request(url)
end end
## ##
@ -333,7 +338,7 @@ class Retailcrm
# #
def stores def stores
url = "#{@rr_url}reference/stores" url = "#{@rr_url}reference/stores"
return make_request(url) make_request(url)
end end
@ -343,13 +348,14 @@ class Retailcrm
# #
def statistic_update def statistic_update
url = "#{@rr_url}statistic/update" url = "#{@rr_url}statistic/update"
return make_request(url) make_request(url)
end end
protected protected
def make_request(url, method='get') def make_request(url, method='get')
raise ArgumentError, 'url must be not empty' unless !url.empty? raise ArgumentError, 'url must be not empty' unless !url.empty?
filter = nil
uri = URI.parse(url) uri = URI.parse(url)
https = Net::HTTP.new(uri.host, uri.port) https = Net::HTTP.new(uri.host, uri.port)
https.use_ssl = true https.use_ssl = true
@ -357,30 +363,29 @@ class Retailcrm
request = Net::HTTP::Post.new(uri) request = Net::HTTP::Post.new(uri)
request.set_form_data(@rr_params) request.set_form_data(@rr_params)
elsif method == 'get' elsif method == 'get'
unless @rr_params[:filter].nil?
filter = @rr_params[:filter].to_a.map { |x| "filter[#{x[0]}]=#{x[1]}" }.join("&")
end
request = Net::HTTP::Get.new(uri.path) request = Net::HTTP::Get.new(uri.path)
request.set_form_data(@rr_params) request.set_form_data(@rr_params)
request = Net::HTTP::Get.new("#{uri.path}?#{request.body}") data = filter.nil? ? "#{request.body}" : "#{request.body}&#{filter}"
request = Net::HTTP::Get.new("#{uri.path}?#{data}")
end end
response = https.request(request) response = https.request(request)
return Retailcrm::Response.new(response.code, response.body) Retailcrm::Response.new(response.code, response.body)
end end
end end
class Retailcrm::Response class Retailcrm::Response
attr_reader :status, :response
def initialize(status, body) def initialize(status, body)
@status = status @status = status
@response = body.empty? ? [] : JSON.parse(body); @response = body.empty? ? [] : JSON.parse(body)
end end
def get_status
return @status
end
def get_response
return @response
end
def is_successfull? def is_successfull?
return @status.to_i < 400 @status.to_i < 400
end end
end end

14
test/spec_retailcrm.rb
View File

@ -8,19 +8,19 @@ require_relative './bootstrap'
describe Retailcrm do describe Retailcrm do
before do before do
@boot = Bootstrap.new() @boot = Bootstrap.new
@api = Retailcrm.new(@boot.api_url, @boot.api_key) @api = Retailcrm.new(@boot.api_url, @boot.api_key)
end end
describe "#delivery services status code" do describe '#delivery services status code' do
it "checks successful status code of delivery services" do it 'checks successful status code of delivery services' do
@api.delivery_services.get_status.to_i.must_be :<, 400 @api.delivery_services.status.to_i.must_be :<, 400
end end
end end
describe "#delivery types status code" do describe '#delivery types status code' do
it "checks successful status code of delivery types" do it 'checks successful status code of delivery types' do
@api.delivery_types.get_status.to_i.must_be :<, 400 @api.delivery_types.status.to_i.must_be :<, 400
end end
end end
end end

2
test/test_retailcrm.rb
View File

@ -6,7 +6,7 @@ require_relative './bootstrap'
class RetailcrmTest < Minitest::Test class RetailcrmTest < Minitest::Test
def setup def setup
@boot = Bootstrap.new() @boot = Bootstrap.new
@api = Retailcrm.new(@boot.api_url, @boot.api_key) @api = Retailcrm.new(@boot.api_url, @boot.api_key)
end end