pixi_client 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c4e906af2abeefa982eba85ec8af7252d18b32b1
-  data.tar.gz: 978ae4cf6668ed4059eab66cb7e6e46e2bda9197
+  metadata.gz: 79ab279f8283d407ffc3a8f93124c1f52b6e2bfb
+  data.tar.gz: 246c56375ce95f560cecd12aa669aacfc9be98ec
 SHA512:
-  metadata.gz: 13fbd1caeeb20063f636971f48f3593de23b0daeea68fee89f8a4969c59026814abd88cca442a056c68d63b0b9164a1e44ad860cf5f1bc50eecd4ffa4fd0a005
-  data.tar.gz: f648ce0eb0035836a6600dcbbd0a192a5ea164f1afbb0b50860c7ac23916acb85fed744eba7ba675fb05ceeb0bc69e34cc764754d86187bd0b996cfcc5b978e3
+  metadata.gz: 8c647a3c2a06b0c04589df953e2e4169a50e44b71c16f8a2c1520ed246a43c04435300de8007b137324bf3738c65c6d4556ebefedeef868a551e7e58a8d25969
+  data.tar.gz: d134a39d8621b889ee016cb458f4697efb4e2761254c308cc2f3a3a2e31e0fce72512a4b6d0d9542439eeb1bca4c3cdb90116752130ec1fd7fd9f45a48b82437

data/README.md

@@ -46,9 +46,23 @@ Or install it yourself as:
 
 ### Configuration
 
-#### Rails
+#### Rails (with cached wsdl document)
 
-config/initializers/pixi_client.rb
+
+run ```bundle exec rake pixi_client:download_wsdl``` in your Rails app root and add the following initializer to the project.
+
+```ruby
+PixiClient.configure do |config|
+  config.endpoint = <your_pixi_endpoing_url>
+  config.username = <your_pixi_username>
+  config.password = <your_pixi_password>
+  config.wsdl     = "#{Rails.root}/config/pixi_client.wsdl"
+end
+```
+
+#### Rails (with remote wsdl document)
+
+If you don't want to cache the ```wsdl``` you can omit that variable in the initializer. The gem will then download the wdsl document at each request and your configuration will look like:
 
 ```ruby
 PixiClient.configure do |config|
@@ -58,6 +72,7 @@ PixiClient.configure do |config|
 end
 ```
 
+
 ### Example of usage
 
 To have a list of the implemented requests, have a look to the lib/requests folder.

data/lib/pixi_client.rb

@@ -1,8 +1,10 @@
 require 'pixi_client/version'
+require 'pixi_client/error'
 require 'pixi_client/configuration'
 require 'pixi_client/response_parser'
 require 'pixi_client/response'
 require 'pixi_client/requests'
+require 'pixi_client/railtie' if defined?(Rails)
 
 module PixiClient
   class << self

data/lib/pixi_client/configuration.rb

@@ -1,5 +1,11 @@
 module PixiClient
   class Configuration
-    attr_accessor :endpoint, :username, :password
+    attr_accessor :endpoint, :username, :password, :wsdl
+
+    def wsdl_document
+      wsdl || endpoint || raise(PixiClient::Error.new("A 'wsdl' or 'endpoint' must be configured"))
+      wsdl ? wsdl : endpoint + '?wsdl'
+    end
+
   end
 end

data/lib/pixi_client/error.rb

@@ -0,0 +1,4 @@
+module PixiClient
+  class Error < StandardError
+  end
+end

data/lib/pixi_client/railtie.rb

@@ -0,0 +1,11 @@
+require 'rails'
+
+module PixiClientRailtie
+  class Railtie < Rails::Railtie
+    railtie_name :pixi_client
+
+    rake_tasks do
+      load 'tasks/pixi_client.rake'
+    end
+  end
+end

data/lib/pixi_client/requests.rb

@@ -9,6 +9,7 @@ require 'pixi_client/requests/get_invoice'
 require 'pixi_client/requests/get_item_info'
 require 'pixi_client/requests/get_order_comments'
 require 'pixi_client/requests/set_stock_multiple'
+require 'pixi_client/requests/get_item_stock'
 require 'pixi_client/requests/get_item_stock_bins'
 require 'pixi_client/requests/get_items_info'
 require 'pixi_client/requests/get_items_on_stock_bin'

data/lib/pixi_client/requests/base.rb

@@ -15,7 +15,9 @@ module PixiClient
 
       def client
         @client ||= Savon.client(
-          wsdl: PixiClient.configuration.endpoint + '?wsdl',
+          wsdl: PixiClient.configuration.wsdl_document,
+          open_timeout: 300,
+          read_timeout: 300,
           ssl_verify_mode: :none,
           basic_auth: [PixiClient.configuration.username, PixiClient.configuration.password]
         )

data/lib/pixi_client/requests/get_item_stock.rb

@@ -0,0 +1,23 @@
+module PixiClient
+  module Requests
+    class GetItemStock < Base
+      include Itemable
+
+      attr_accessor :item_id_key, :item_id
+
+      def initialize(item_id_key, item_id)
+        self.item_id_key = item_id_key
+        self.item_id = item_id
+      end
+
+      def message
+        { item_id_key_to_param => item_id, 'LocationStock' => 1}
+      end
+
+      def api_method
+        :pixi_get_item_stock
+      end
+    end
+  end
+end
+

data/lib/pixi_client/version.rb

@@ -1,3 +1,3 @@
 module PixiClient
-  VERSION = "1.0.0"
+  VERSION = "1.1.0"
 end

data/lib/tasks/pixi_client.rake

@@ -0,0 +1,24 @@
+require 'open-uri'
+require 'openssl'
+
+namespace :pixi_client do
+  desc 'Create the file config/pixi_client.wsdl'
+  task :download_wsdl do
+    config = YAML.load_file(File.join([Rails.root, 'config', 'pixi.yml']))[Rails.env]
+
+    OpenSSL::SSL::VERIFY_PEER = OpenSSL::SSL::VERIFY_NONE # needed due to the context
+
+    File.open('config/pixi_client.wsdl', "wb") do |wsdl_file|
+      # the following "open" is provided by open-uri
+      open(config['url'] + '?wsdl',
+        http_basic_authentication: [config['username'], config['password']]) do |document|
+          wsdl_file.write(document.read)
+          puts 'file downloaded in config/pixi_client.wsdl'
+      end
+    end
+
+  end
+
+  task :install => [:download_wsdl] do
+  end
+end

data/spec/lib/pixi_client/configuration_spec.rb

@@ -11,6 +11,12 @@ describe PixiClient::Configuration do
       end
     end
 
+    describe '#wsdl' do
+      it 'should be nil' do
+        expect(subject.wsdl).to be_nil
+      end
+    end
+
     describe '#username' do
       it 'should be nil' do
         expect(subject.username).to be_nil
@@ -22,12 +28,39 @@ describe PixiClient::Configuration do
         expect(subject.password).to be_nil
       end
     end
+
+    describe '#wsdl_document' do
+      it 'should raise an error' do
+        expect {
+          subject.wsdl_document
+          }.to raise_error(PixiClient::Error, "A 'wsdl' or 'endpoint' must be configured")
+      end
+    end
   end
 
-  describe '#endpoint=' do
-    it 'sets the endpoint' do
-      subject.endpoint = 'endpoint_url'
-      expect(subject.endpoint).to eq 'endpoint_url'
+  describe '#wsdl_document' do
+    context 'when and endpoint is set' do
+      it 'returns the remote wsdl document' do
+        subject.endpoint = 'endpoint_url'
+        subject.wsdl = nil
+        expect(subject.wsdl_document).to eq('endpoint_url?wsdl')
+      end
+    end
+    context 'when and wsdl file is set' do
+      it 'returns the local wsdl document' do
+        subject.endpoint = nil
+        subject.wsdl = 'path/to/endpoint.xml'
+        expect(subject.wsdl_document).to eq('path/to/endpoint.xml')
+      end
+    end
+    context 'when no wsdl or file is set' do
+      it 'raises an error' do
+        subject.endpoint = nil
+        subject.wsdl = nil
+        expect {
+          subject.wsdl_document
+          }.to raise_error(PixiClient::Error, "A 'wsdl' or 'endpoint' must be configured")
+      end
     end
   end
 
@@ -38,6 +71,13 @@ describe PixiClient::Configuration do
     end
   end
 
+  describe '#wsdl=' do
+    it 'sets the wsdl' do
+      subject.wsdl = 'wsdl_set'
+      expect(subject.wsdl).to eq 'wsdl_set'
+    end
+  end
+
   describe '#password=' do
     it 'sets the password' do
       subject.password = 'random-password'

data/spec/lib/pixi_client/error_spec.rb

@@ -0,0 +1,15 @@
+require 'spec_helper'
+
+describe PixiClient::Error do
+
+  subject { PixiClient::Error.new }
+
+  it 'should accept a message' do
+    begin
+      raise PixiClient::Error.new('Something happend')
+    rescue => e
+      expect(e.class).to eq(PixiClient::Error)
+      expect(e.message).to eq('Something happend')
+    end
+  end
+end

data/spec/lib/pixi_client/requests/get_item_stock_spec.rb

@@ -0,0 +1,47 @@
+require 'spec_helper'
+
+describe PixiClient::Requests::GetItemStock do
+
+  subject { PixiClient::Requests::GetItemStock.new(:ean, 1) }
+
+  before do
+    set_default_config
+  end
+
+  it { is_expected.to be_a_kind_of(PixiClient::Requests::Base) }
+
+  describe '#api_method' do
+    it 'should return :pixi_get_item_stock' do
+      expect(subject.api_method).to eq :pixi_get_item_stock
+    end
+  end
+
+  describe 'call behaviour' do
+    let(:expected_response) { double(body: { pixi_get_item_stock_response: { pixi_get_item_stock_result: sql_row_set_response_mock } }) }
+    let(:double_client) { double }
+
+    before do
+      allow(subject).to receive(:client).and_return(double_client)
+    end
+
+    it 'should call the client with the appropriate parameters' do
+      expect(double_client).to receive(:call)
+      .with(:pixi_get_item_stock, attributes: { xmlns: PixiClient.configuration.endpoint }, message: { 'EAN' => 1, "LocationStock"=>1 })
+      .and_return(expected_response)
+
+      subject.call
+    end
+
+    it 'should instanciate an instance of Response with the response body' do
+      expect(double_client).to receive(:call).and_return(expected_response)
+      expect(PixiClient::Response).to receive(:new).with(:pixi_get_item_stock, expected_response.body)
+      subject.call
+    end
+
+    it 'should return an instance of Response' do
+      expect(double_client).to receive(:call).and_return(expected_response)
+      expect(subject.call).to be_an_instance_of(PixiClient::Response)
+    end
+  end
+
+end

data/spec/lib/pixi_client_spec.rb

@@ -6,6 +6,7 @@ describe PixiClient do
       configuration.endpoint = 'endpoint'
       configuration.username = 'username'
       configuration.password = 'random-password'
+      configuration.wsdl     = 'some/path/somewhere.wsdl'
     end
   end
 
@@ -14,6 +15,7 @@ describe PixiClient do
       expect(PixiClient.configuration.endpoint).to eq 'endpoint'
       expect(PixiClient.configuration.username).to eq 'username'
       expect(PixiClient.configuration.password).to eq 'random-password'
+      expect(PixiClient.configuration.wsdl).to eq 'some/path/somewhere.wsdl'
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pixi_client
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - heragu
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-09-10 00:00:00.000000000 Z
+date: 2016-12-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: savon
@@ -180,6 +180,8 @@ files:
 - Rakefile
 - lib/pixi_client.rb
 - lib/pixi_client/configuration.rb
+- lib/pixi_client/error.rb
+- lib/pixi_client/railtie.rb
 - lib/pixi_client/requests.rb
 - lib/pixi_client/requests/add_comment_to_order.rb
 - lib/pixi_client/requests/base.rb
@@ -189,6 +191,7 @@ files:
 - lib/pixi_client/requests/get_changed_items.rb
 - lib/pixi_client/requests/get_invoice.rb
 - lib/pixi_client/requests/get_item_info.rb
+- lib/pixi_client/requests/get_item_stock.rb
 - lib/pixi_client/requests/get_item_stock_bins.rb
 - lib/pixi_client/requests/get_items_info.rb
 - lib/pixi_client/requests/get_items_on_stock_bin.rb
@@ -210,11 +213,13 @@ files:
 - lib/pixi_client/response.rb
 - lib/pixi_client/response_parser.rb
 - lib/pixi_client/version.rb
+- lib/tasks/pixi_client.rake
 - pixi_client.gemspec
 - spec/fixtures/get_order_nr_external_by_box_nr.xml
 - spec/fixtures/pixi_get_changed_item_stock.xml
 - spec/integration/pixi_get_changed_item_stock_spec.rb
 - spec/lib/pixi_client/configuration_spec.rb
+- spec/lib/pixi_client/error_spec.rb
 - spec/lib/pixi_client/requests/add_comment_to_order_spec.rb
 - spec/lib/pixi_client/requests/cancel_order_line_spec.rb
 - spec/lib/pixi_client/requests/cancel_order_spec.rb
@@ -223,6 +228,7 @@ files:
 - spec/lib/pixi_client/requests/get_invoice_spec.rb
 - spec/lib/pixi_client/requests/get_item_info_spec.rb
 - spec/lib/pixi_client/requests/get_item_stock_bins_spec.rb
+- spec/lib/pixi_client/requests/get_item_stock_spec.rb
 - spec/lib/pixi_client/requests/get_items_info_spec.rb
 - spec/lib/pixi_client/requests/get_items_on_stock_bin_spec.rb
 - spec/lib/pixi_client/requests/get_items_stock_history_spec.rb
@@ -265,7 +271,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.8
+rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
 summary: SOAP Pixi* API client
@@ -274,6 +280,7 @@ test_files:
 - spec/fixtures/pixi_get_changed_item_stock.xml
 - spec/integration/pixi_get_changed_item_stock_spec.rb
 - spec/lib/pixi_client/configuration_spec.rb
+- spec/lib/pixi_client/error_spec.rb
 - spec/lib/pixi_client/requests/add_comment_to_order_spec.rb
 - spec/lib/pixi_client/requests/cancel_order_line_spec.rb
 - spec/lib/pixi_client/requests/cancel_order_spec.rb
@@ -282,6 +289,7 @@ test_files:
 - spec/lib/pixi_client/requests/get_invoice_spec.rb
 - spec/lib/pixi_client/requests/get_item_info_spec.rb
 - spec/lib/pixi_client/requests/get_item_stock_bins_spec.rb
+- spec/lib/pixi_client/requests/get_item_stock_spec.rb
 - spec/lib/pixi_client/requests/get_items_info_spec.rb
 - spec/lib/pixi_client/requests/get_items_on_stock_bin_spec.rb
 - spec/lib/pixi_client/requests/get_items_stock_history_spec.rb