plenty_client 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7180904868c8a02d469c837d0ebc23bd45771173
-  data.tar.gz: 210526fc22be311c647f257190508ed53c6b720f
+  metadata.gz: 1e689726c8a6699f7c57b32f82c9cfa6b969c43e
+  data.tar.gz: 3f99888156deccc95fa7d013f39eb4ebcf1deb54
 SHA512:
-  metadata.gz: 4fa101d7f1462504fc8a7a643633f640fa9898f903e75fd86e7c5efa01d21f873e4f653002ed27b71c79853f3c47b24f88e6ad40ac5bbec00fd63ec4babe48e1
-  data.tar.gz: 4e7b8cd5d34d56c2148f38c0c11dd316d9b2456c51ea6daa071f01b7d398def13d406abcdd78fa5894b474aabc9e261577425fc6064ae4cda526c487e320b354
+  metadata.gz: 92fc5e2f051a125639bbd5c1c6bec651cd22b55e71a9681426dc8d899959c157189e3ec26d2440a1d403e710edab13838e2f4148cff6265649cab0b681bfe79f
+  data.tar.gz: 655b49ac1d5a8859049fd3fcd20d34a707328854ffbdde49beba7c74a50feb6cb5ff42bcf88a5c9862a2796cabde853a2a29e8a1f4e9a8c7c4bff0a69089bb74

data/.rubocop.yml

@@ -1,6 +1,6 @@
 # This is the configuration used to check the rubocop source code.
 AllCops:
-  TargetRubyVersion: 2.3
+  TargetRubyVersion: 2.4
   Exclude:
     - 'db/schema.rb'
 Lint/HandleExceptions:

data/README.md

@@ -36,15 +36,16 @@ PlentyClient::Config.site_url     = 'http://plenty7.plentymarkets.de/rest'
 PlentyClient::Config.api_user     = 'myusername'
 PlentyClient::Config.api_password = 'mypassword'
 PlentyClient::Config.log          = true || false
+PlentyClient::Config.plenty_id    = 111111
 ```
 
 # Calls
-Once you are set up you can use the client with the following methods:  
-
 Note:
-  - required parameters need to be passed in, otherwise you will get an error
+  - required parameters need to be passed in, otherwise you will receive an PlentyClient::ResponseError
   - This Client handles no validation, it is only a gateway to the API
 
+Once you are set up you can use the client like so:  
+
 ```ruby
 PlentyClient::Item.find(103)
 PlentyClient::Item::Variation.find(103, 105)
@@ -56,52 +57,23 @@ PlentyClient::Item.create(parameters)
 
 PlentyClient::Item::Variation.update(103, update_parameters)
 
-PlentyClient::Item::Variation.delete(103, 105)
-
-```
-
-### Blocks
+PlentyClient::Item::Variation.destroy(103, 105)
 
-```ruby
 # Use blocks to iterate in batches
 PlentyClient::Item.list do |item|
   puts item
 end
 
 # You can set optional headers after the required parameters of each request
-PlentyClient::Item::Variation.list(103, {'itemsPerPage' => 1, 'page' => 4}) do |item|
+PlentyClient::Item::Variation.list(103, { 'itemsPerPage' => 1, 'page' => 4 }) do |item|
   puts item
 end
 ```
 
-### HTTP-Methods
-
-If there is no resource available you can still make the request like so:
-```ruby
-PlentyClient::Request.patch(path, body = {})
-PlentyClient::Request.put(path, body = {})
-PlentyClient::Request.post(path, body = {})
-PlentyClient::Request.delete(path, params = {})
-PlentyClient::Request.get(path, params = {})
-PlentyClient::Request.get(path, params = {}) do |body|
-end
-```
-
 ### Warnings
 There is a difference in the get method with and without a block.
-This returns the raw body with all parameters
-
-```ruby
-PlentyClient::Request.get(path, params = {})
-
-```
-The get-call with the block only returns the entries
-```ruby
-PlentyClient::Request.get(path, params = {}) do |body|
-  puts entries
-end
-
-```
+The Call without the block will return the complete response.  
+With the block you will only receive the entries.
 
 ### Debugging
 If you are not sure which required parameters to pass in simply call
@@ -128,6 +100,7 @@ PlentyClient::Item::Variation.routes
   * [`ExportSettings`](https://developers.plentymarkets.com/rest-doc/export_settings)
   * [~~`Item`~~](https://developers.plentymarkets.com/rest-doc/item)
   * [`LegalInformation`](https://developers.plentymarkets.com/rest-doc/legal_information)
+  * [`Listing`](https://developers.plentymarkets.com/rest-doc/listing)
   * [`Market`](https://developers.plentymarkets.com/rest-doc/market)
   * [~~`Order`~~](https://developers.plentymarkets.com/rest-doc/order)
   * [`OrderSummary`](https://developers.plentymarkets.com/rest-doc/order_summary)

data/Rakefile

@@ -1,6 +1,6 @@
-require "bundler/gem_tasks"
-require "rspec/core/rake_task"
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
 
 RSpec::Core::RakeTask.new(:spec)
 
-task :default => :spec
+task default: :spec

data/lib/plenty_client.rb

@@ -2,11 +2,13 @@ require 'curl'
 require 'json'
 
 module PlentyClient
-  autoload :Config,     'plenty_client/config'
-  autoload :Constants,  'plenty_client/constants'
-  autoload :Endpoint,   'plenty_client/endpoint'
-  autoload :Request,    'plenty_client/request'
-  autoload :Version,    'plenty_client/version'
+  class ResponseError < StandardError; end
+
+  autoload :Config,       'plenty_client/config'
+  autoload :Constants,    'plenty_client/constants'
+  autoload :Endpoint,     'plenty_client/endpoint'
+  autoload :Request,      'plenty_client/request'
+  autoload :Version,      'plenty_client/version'
 
   autoload :Accounting,     'plenty_client/accounting'
   autoload :Authentication, 'plenty_client/authentication'
@@ -38,6 +40,7 @@ module PlentyClient
     autoload :PropertyGroupName,          'plenty_client/item/property_group_name'
     autoload :SalesPrice,                 'plenty_client/item/sales_price'
     autoload :SalesPriceShippingProfile,  'plenty_client/item/sales_price_shipping_profile'
+    autoload :ShippingProfile,            'plenty_client/item/shipping_profile'
     autoload :Unit,                       'plenty_client/item/unit'
     autoload :UnitName,                   'plenty_client/item/unit_name'
     autoload :Variation,                  'plenty_client/item/variation'

data/lib/plenty_client/accounting.rb

@@ -1,7 +1,7 @@
 module PlentyClient
   module Accounting
-    extend PlentyClient::Endpoint
-    extend PlentyClient::Request
+    include PlentyClient::Endpoint
+    include PlentyClient::Request
 
     LIST_VAT_OF_LOCATION    = '/vat/locations/{locationId}'.freeze
     LIST_VAT_OF_COUNTRY     = '/vat/locations/{locationId}/countries/{countryId}'.freeze

data/lib/plenty_client/authentication.rb

@@ -1,7 +1,7 @@
 module PlentyClient
   module Authentication
-    extend PlentyClient::Endpoint
-    extend PlentyClient::Request
+    include PlentyClient::Endpoint
+    include PlentyClient::Request
 
     AUTH_LOGIN    = '/login'.freeze
     AUTH_REFRESH  = '/login/refresh'.freeze

data/lib/plenty_client/authorization.rb

@@ -1,7 +1,7 @@
 module PlentyClient
   module Authorization
-    extend PlentyClient::Endpoint
-    extend PlentyClient::Request
+    include PlentyClient::Endpoint
+    include PlentyClient::Request
 
     AUTH_USER                = '/authorized_user'.freeze
     AUTH_USER_WITH_UI_CONFIG = '/user/authorized_user_with_ui_config'.freeze

data/lib/plenty_client/basket.rb

@@ -1,7 +1,7 @@
 module PlentyClient
   module Basket
-    extend PlentyClient::Endpoint
-    extend PlentyClient::Request
+    include PlentyClient::Endpoint
+    include PlentyClient::Request
 
     FIND_BASKET = '/basket'.freeze
 

data/lib/plenty_client/basket/item.rb

@@ -1,8 +1,8 @@
 module PlentyClient
   module Basket
     class Item
-      extend PlentyClient::Endpoint
-      extend PlentyClient::Request
+      include PlentyClient::Endpoint
+      include PlentyClient::Request
 
       CREATE_BASKET_ITEM  = '/basket/items'.freeze
       LIST_BASKET_ITEMS   = '/basket/items'.freeze

data/lib/plenty_client/category.rb

@@ -1,7 +1,7 @@
 module PlentyClient
   module Category
-    extend PlentyClient::Endpoint
-    extend PlentyClient::Request
+    include PlentyClient::Endpoint
+    include PlentyClient::Request
 
     FIND_CATEGORY           = '/categories/{catId}'.freeze
     LIST_CATEGORIES         = '/categories'.freeze
@@ -26,23 +26,22 @@ module PlentyClient
       end
 
       def update(cat_id, body = {})
-        post(build_endpoint(UPDATE_CATEGORY,
-                            cat: cat_id), body)
+        post(build_endpoint(UPDATE_CATEGORY, cat: cat_id), body)
       end
 
       def update_all(body = {})
         post(build_endpoint(UPDATE_CATEGORIES), body)
       end
 
-      def delete(cat_id, body = {})
+      def destroy(cat_id, body = {})
         delete(build_endpoint(DELETE_CATEGORY, cat: cat_id), body)
       end
 
-      def delete_details(cat_id, body = {})
+      def destroy_details(cat_id, body = {})
         delete(build_endpoint(DELETE_CATEGORY_DETAILS, cat: cat_id), body)
       end
 
-      def delete_clients(cat_id, body = {})
+      def destroy_clients(cat_id, body = {})
         delete(build_endpoint(DELETE_CATEGORY_CLIENTS, cat: cat_id), body)
       end
     end

data/lib/plenty_client/category/branch.rb

@@ -1,8 +1,8 @@
 module PlentyClient
   module Category
     class Branch
-      extend PlentyClient::Endpoint
-      extend PlentyClient::Request
+      include PlentyClient::Endpoint
+      include PlentyClient::Request
 
       FIND_CATEGORY_BRANCH = '/category_branches/{catId}'.freeze
       LIST_CATEGORY_BRANCH = '/category_branches'.freeze

data/lib/plenty_client/category/template.rb

@@ -1,8 +1,8 @@
 module PlentyClient
   module Category
     class Template
-      extend PlentyClient::Endpoint
-      extend PlentyClient::Request
+      include PlentyClient::Endpoint
+      include PlentyClient::Request
 
       FIND_CATEGORY_TEMPLATE    = '/categories/{catId}/templates'.freeze
       UPDATE_CATEGORY_TEMPLATE  = '/categories/{catId}/templates'.freeze
@@ -19,7 +19,7 @@ module PlentyClient
                              cat: cat_id), body)
         end
 
-        def delete(cat_id, body = {})
+        def destroy(cat_id, body = {})
           delete(build_endpoint(DELETE_CATEGORY_TEMPLATE,
                                 cat: cat_id), body)
         end

data/lib/plenty_client/comment.rb

@@ -1,7 +1,7 @@
 module PlentyClient
   module Comment
-    extend PlentyClient::Endpoint
-    extend PlentyClient::Request
+    include PlentyClient::Endpoint
+    include PlentyClient::Request
 
     FIND_COMMENT    = '/comments/{commentId}'.freeze
     LIST_COMMENTS   = '/comments/{referenceType}/{referenceValue}'.freeze
@@ -23,7 +23,7 @@ module PlentyClient
         post(CREATE_CATEGORY, body)
       end
 
-      def delete(cat_id, body = {})
+      def destroy(cat_id, body = {})
         delete(build_endpoint(DELETE_CATEGORY, comment: cat_id), body)
       end
     end

data/lib/plenty_client/config.rb

@@ -2,13 +2,15 @@ module PlentyClient
   class Config
     class NoCredentials < StandardError; end
     class NoToken < StandardError; end
+    class NoPlentyId < StandardError; end
 
     class << self
-      attr_accessor :site_url, :api_user, :api_password, :access_token, :refresh_token, :log
+      attr_accessor :site_url, :api_user, :api_password, :access_token, :refresh_token, :log, :expiry_date, :plenty_id
 
       def validate
         raise NoCredentials if site_url.nil? || api_user.nil? || api_password.nil?
         raise NoToken if access_token.nil? || refresh_token.nil?
+        raise NoPlentyId if plenty_id.blank?
       end
     end
   end

data/lib/plenty_client/endpoint.rb

@@ -1,77 +1,83 @@
 module PlentyClient
   module Endpoint
-    # Method that replaces the arguments in an endpoint with the given parameters.
-    # Arguments that are passed to the build_endpoint method, but do not
-    # live in the endpoint, are discarded.
-    def build_endpoint(api_endpoint_template, arguments = {})
-      # Duplicate constant to temporary endpoint string
-      api_endpoint_result = api_endpoint_template.dup
-      # Endpoint parameters hash that links symbols to regex
-      endpoint_parameters = {
-        account:                    /\{accountId\}/,
-        account_ype:                /\{accountType\}/,
-        attribute:                  /\{attributeId\}/,
-        attribute_value:            /\{attributeValueId\}/,
-        barcode:                    /\{barcodeId\}/,
-        bundle:                     /\{bundleId\}/,
-        cat:                        /\{catId\}/,
-        commission:                 /\{commissionId\}/,
-        component:                  /\{componentId\}/,
-        comment:                    /\{commentId\}/,
-        contact:                    /\{contactId\}/,
-        country:                    /\{countryId\}/,
-        coupon_string:              /\{coupon\}/,
-        cross_item:                 /\{crossItemId\}/,
-        currency:                   /\{currencyIso\}/,
-        customer_class:             /\{customerClassId\}/,
-        image:                      /\{imageId\}/,
-        item:                       /\{itemId\}/,
-        item_set:                   /\{itemSetId\}/,
-        lang:                       /\{lang\}/,
-        location:                   /\{locationId\}/,
-        manufacturer:               /\{manufacturerId\}/,
-        market:                     /\{marketId\}/,
-        market_ident_number:        /\{marketIdentNumberId\}/,
-        marketplace:                /\{marketplaceId\}/,
-        order:                      /\{orderId\}/,
-        order_item:                 /\{orderItemId\}/,
-        parent_referrer:            /\{parentReferrerId\}/,
-        plenty:                     /\{plentyId\}/,
-        preset:                     /\{presetId\}/,
-        price:                      /\{priceId\}/,
-        property_group:             /\{propertyGroupId\}/,
-        property:                   /\{propertyId\}/,
-        referrer:                   /\{referrerId\}/,
-        reference_type:             /\{referenceType\}/,
-        reference_value:            /\{referenceValue\}/,
-        sales_price:                /\{salesPriceId\}/,
-        shipping_profile:           /\{shippingProfileId\}/,
-        shipping_package:           /\{orderShippingPackageId\}/,
-        shipping_service_provider:  /\{shippingServiceProviderID\}/,
-        sku:                        /\{skuId\}/,
-        type:                       /\{typeId\}/,
-        type_string:                /\{type\}/,
-        unit:                       /\{unitId\}/,
-        value:                      /\{valueId\}/,
-        variation:                  /\{variationId\}/,
-        variation_supplier:         /\{variationSupplierId\}/,
-        warehouse:                  /\{warehouseId\}/,
-        webstore:                   /\{webstoreId\}/
-      }
-      # Loop over the given argument symbols, retrieve the corresponding regex
-      # and replace the argument with the corresponding value.
-      arguments.each do |k, v|
-        api_endpoint_result.gsub!(endpoint_parameters.fetch(k), v.to_s)
+    module ClassMethods
+      # Method that replaces the arguments in an endpoint with the given parameters.
+      # Arguments that are passed to the build_endpoint method, but do not
+      # live in the endpoint, are discarded.
+      def build_endpoint(api_endpoint_template, arguments = {})
+        # Duplicate constant to temporary endpoint string
+        api_endpoint_result = api_endpoint_template.dup
+        # Endpoint parameters hash that links symbols to regex
+        endpoint_parameters = {
+          account:                    /\{accountId\}/,
+          account_ype:                /\{accountType\}/,
+          attribute:                  /\{attributeId\}/,
+          attribute_value:            /\{attributeValueId\}/,
+          barcode:                    /\{barcodeId\}/,
+          bundle:                     /\{bundleId\}/,
+          cat:                        /\{catId\}/,
+          commission:                 /\{commissionId\}/,
+          component:                  /\{componentId\}/,
+          comment:                    /\{commentId\}/,
+          contact:                    /\{contactId\}/,
+          country:                    /\{countryId\}/,
+          coupon_string:              /\{coupon\}/,
+          cross_item:                 /\{crossItemId\}/,
+          currency:                   /\{currencyIso\}/,
+          customer_class:             /\{customerClassId\}/,
+          image:                      /\{imageId\}/,
+          item:                       /\{itemId\}/,
+          item_set:                   /\{itemSetId\}/,
+          lang:                       /\{lang\}/,
+          location:                   /\{locationId\}/,
+          manufacturer:               /\{manufacturerId\}/,
+          market:                     /\{marketId\}/,
+          market_ident_number:        /\{marketIdentNumberId\}/,
+          marketplace:                /\{marketplaceId\}/,
+          order:                      /\{orderId\}/,
+          order_item:                 /\{orderItemId\}/,
+          parent_referrer:            /\{parentReferrerId\}/,
+          plenty:                     /\{plentyId\}/,
+          preset:                     /\{presetId\}/,
+          price:                      /\{priceId\}/,
+          property_group:             /\{propertyGroupId\}/,
+          property:                   /\{propertyId\}/,
+          referrer:                   /\{referrerId\}/,
+          reference_type:             /\{referenceType\}/,
+          reference_value:            /\{referenceValue\}/,
+          sales_price:                /\{salesPriceId\}/,
+          shipping_profile:           /\{shippingProfileId\}/,
+          shipping_package:           /\{orderShippingPackageId\}/,
+          shipping_service_provider:  /\{shippingServiceProviderID\}/,
+          sku:                        /\{skuId\}/,
+          type:                       /\{typeId\}/,
+          type_string:                /\{type\}/,
+          unit:                       /\{unitId\}/,
+          value:                      /\{valueId\}/,
+          variation:                  /\{variationId\}/,
+          variation_supplier:         /\{variationSupplierId\}/,
+          warehouse:                  /\{warehouseId\}/,
+          webstore:                   /\{webstoreId\}/
+        }
+        # Loop over the given argument symbols, retrieve the corresponding regex
+        # and replace the argument with the corresponding value.
+        arguments.each do |k, v|
+          api_endpoint_result.gsub!(endpoint_parameters.fetch(k), v.to_s)
+        end
+
+        api_endpoint_result
       end
 
-      api_endpoint_result
+      def routes
+        # Prints all available routes with their values in the given module
+        constants.each do |const|
+          puts "#{const}: \t #{const_get(const)}" if const.to_s.upcase!.nil?
+        end
+      end
     end
 
-    def routes
-      # Prints all available routes with their values in the given module
-      constants.each do |const|
-        puts "#{const}: \t #{const_get(const)}" if const.to_s.upcase!.nil?
-      end
+    def self.included(base)
+      base.extend(ClassMethods)
     end
   end
 end