elibri_api_client 1.0.1

data/.document

@@ -0,0 +1,5 @@
+lib/**/*.rb
+bin/*
+- 
+features/**/*.feature
+LICENSE.txt

data/Gemfile

@@ -0,0 +1,13 @@
+source "http://rubygems.org"
+
+gem "httparty", "~> 0.7.8"
+gem "nokogiri", "~> 1.4.6"
+
+group :development do
+  gem "ruby-debug"
+  gem "mocha"
+  gem "minitest", ">= 0"
+  gem "bundler", "~> 1.0.0"
+  gem "jeweler", "~> 1.6.2"
+  gem "rcov", ">= 0"
+end

data/Gemfile.lock

@@ -0,0 +1,38 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    columnize (0.3.3)
+    crack (0.1.8)
+    git (1.2.5)
+    httparty (0.7.8)
+      crack (= 0.1.8)
+    jeweler (1.6.2)
+      bundler (~> 1.0)
+      git (>= 1.2.5)
+      rake
+    linecache (0.46)
+      rbx-require-relative (> 0.0.4)
+    minitest (2.2.2)
+    mocha (0.9.12)
+    nokogiri (1.4.6)
+    rake (0.9.0)
+    rbx-require-relative (0.0.5)
+    rcov (0.9.9)
+    ruby-debug (0.10.4)
+      columnize (>= 0.1)
+      ruby-debug-base (~> 0.10.4.0)
+    ruby-debug-base (0.10.4)
+      linecache (>= 0.3)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.0.0)
+  httparty (~> 0.7.8)
+  jeweler (~> 1.6.2)
+  minitest
+  mocha
+  nokogiri (~> 1.4.6)
+  rcov
+  ruby-debug

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2011 Marcin Urbanski
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.rdoc

@@ -0,0 +1,24 @@
+= elibri_api_client
+
+  require 'elibri_api_client'
+  cli = Elibri::ApiClient.new(:host_uri => 'http://localhost:3010', :login => '1b20fa9d72234423979c', :password => '2847cbf4f15a4057e2ab')
+  
+  cli.refill_all_queues!
+  cli.pending_data?
+  cli.last_pickups
+
+  cli.pending_queues.each do |pending_queue|
+    named_queue = pending_queue.pick_up!
+
+    named_queue.each_product do |product_xml, product_no|
+      # [...]
+    end
+  end
+
+
+
+== Copyright
+
+Copyright (c) 2011 elibri.com.pl. See LICENSE.txt for
+further details.
+

data/Rakefile

@@ -0,0 +1,53 @@
+# encoding: utf-8
+
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'rake'
+
+require 'jeweler'
+require './lib/elibri_api_client/version.rb'
+Jeweler::Tasks.new do |gem|
+  gem.name = "elibri_api_client"
+  gem.version = Elibri::ApiClient::Version::STRING
+  gem.homepage = "http://github.com/elibri/elibri_api_client"
+  gem.license = "MIT"
+  gem.summary = %Q{API client for elibri.com.pl publishing system}
+  gem.description = %Q{API client for elibri.com.pl publishing system}
+  gem.email = "marcin@urbanski.vdl.pl"
+  gem.authors = ["Marcin Urbański"]
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/*_test.rb'
+  test.verbose = true
+end
+
+require 'rcov/rcovtask'
+Rcov::RcovTask.new do |test|
+  test.libs << 'test'
+  test.pattern = 'test/**/*_test.rb'
+  test.verbose = true
+  test.rcov_opts << '--exclude "gems/*"'
+end
+
+task :default => :test
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = Elibri::ApiClient::Version::STRING
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "elibri_api_client #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/lib/elibri_api_client/api_adapters/v1.rb

@@ -0,0 +1,171 @@
+require 'elibri_api_client/api_adapters/v1_helpers'
+
+module Elibri
+  class ApiClient
+    module ApiAdapters
+
+      # Adapter dla 1 wersji API
+      class V1
+        URI_PREFIX = '/api/v1'
+
+        include HTTParty
+        debug_output $stderr
+
+
+        def initialize(host_uri, login, password)
+          @host_uri = host_uri
+          @auth = {:username => login, :password => password}
+        end
+
+
+        # Wypełnij wszystkie kolejki oczekujące, wszystkimi dostępnymi danymi. Przydatne przy wykonywaniu
+        # pełnej synchronizacji pomiędzy naszą aplikacją a Elibri.
+        def refill_all_queues!
+          # Dla POST musi być jakieś 'body' requestu, bo serwery często rzucają wyjątkami (WEBrick w szczególności).
+          post '/queues/refill_all', :body => ' '
+        end
+
+
+        # Zwróć listę kolejek z oczekującymi danymi.
+        def pending_queues
+          resp = get '/queues/pending_data'
+
+          pending_queues = []
+          resp.parsed_response.css('queue').each do |queue_xml|
+            queue = Elibri::ApiClient::ApiAdapters::V1::Queue.build_from_xml(self, queue_xml)
+            pending_queues << queue if queue.items_total.nonzero?
+          end  
+          pending_queues
+        end
+
+
+        # Czy są jakieś oczekujące dane w Elibri?
+        def pending_data?
+          !pending_queues.empty?
+        end
+
+
+        # Utwórz z danych oczekujących w kolejce np. 'pending_meta', kolejkę nazwaną.
+        # Tylko z kolejek nazwanych można pobierać dane. Jako argument przyjmuje nazwę kolejki (np. 'pending_meta')
+        # lub odpowiednią instancję Elibri::ApiClient::ApiAdapters::V1::Queue.
+        def pick_up_queue!(queue)
+          case queue
+            when Elibri::ApiClient::ApiAdapters::V1::Queue
+              queue_name = queue.name
+            when String
+              queue_name = queue
+            else
+              raise 'Specify queue as name or Elibri::ApiClient::ApiAdapters::V1::Queue instance'
+          end
+
+          response = post "/queues/#{queue_name}/pick_up", :body => ' '
+          picked_up_queue_xml = response.parsed_response.css('pick_up queue').first
+          Elibri::ApiClient::ApiAdapters::V1::Queue.build_from_xml(self, picked_up_queue_xml)
+        end
+
+
+        def each_page(queue, &block)
+          raise 'Need a Elibri::ApiClient::ApiAdapters::V1::Queue instance' unless queue.kind_of? Elibri::ApiClient::ApiAdapters::V1::Queue
+          
+          page_no = 1
+          response = get "/queues/#{queue.name}/#{queue.queue_id}"
+          yield response.parsed_response.css('current_page content'), page_no
+          while next_page = response.parsed_response.css('next_page').first
+            response = get next_page['url']
+            page_no += 1
+            yield response.parsed_response.css('current_page content').first, page_no
+          end
+        end
+
+
+        def each_product(queue, &block)
+          raise 'Need a Elibri::ApiClient::ApiAdapters::V1::Queue instance' unless queue.kind_of? Elibri::ApiClient::ApiAdapters::V1::Queue
+
+          product_no = 1
+          each_page(queue) do |products_page_xml, page_no|
+            products_page_xml.css('Product').each do |product_xml|
+              block.call(product_xml, product_no)
+              product_no += 1
+            end  
+          end
+        end
+
+
+        # Ostatnio utworzone nazwane kolejki. Gdy wysypie nam się aplikacja, można przeglądać ostatnie pickupy.
+        def last_pickups
+          last_pickups = []
+          %w{meta stocks}.each do |queue_name|
+            begin
+              response = get "/queues/#{queue_name}/last_pick_up"
+              queue_xml = response.parsed_response.css('queue').first
+              last_pickups << Elibri::ApiClient::ApiAdapters::V1::Queue.build_from_xml(self, queue_xml)
+            rescue NoRecentlyPickedUpQueues # Ignoruj błędy o braku ostatnich pickupów.
+            end
+          end  
+          
+          last_pickups
+        end
+
+
+        private
+
+          # http://api.elibri.com.pl:80/api/v1
+          def full_api_uri
+            @host_uri + URI_PREFIX 
+          end
+
+
+          def get(request_uri, options = {})
+            options.merge!({:digest_auth => @auth})
+            request_uri = normalise_request_uri(request_uri)
+
+            response = self.class.get(request_uri, options)
+            raise_if_error_present_in response
+            response
+          end
+
+
+          def post(request_uri, options = {})
+            options.merge!({:digest_auth => @auth})
+            request_uri = normalise_request_uri(request_uri)
+
+            response = self.class.post(request_uri, options)
+            raise_if_error_present_in response
+            response
+          end
+
+
+          def normalise_request_uri(request_uri)
+            if request_uri.start_with? 'http://'
+              request_uri
+            elsif !request_uri.start_with? '/'
+              full_api_uri + '/' + request_uri
+            else
+              full_api_uri + request_uri
+            end
+          end
+
+
+          def raise_if_error_present_in(response)
+            raise Unauthorized, 'Bad login or password' if response.code == 401
+
+            response_xml = response.parsed_response
+            if response_xml && !response_xml.css('error').empty?
+              error_id = response_xml.css('error').first['id']
+              error_message = response_xml.css('error message').first.text
+
+              # Rozpoznajemy ten kod błędu i możemy rzucić określoną klasą wyjątku:
+              if exception_class = EXCEPTION_CLASSES[error_id.to_s]
+                raise exception_class, error_message
+              else
+                # Jakiś nieznany błąd - rzucamy chociaż stringiem
+                raise UnknownError, "ELIBRI_API ERROR #{error_id}: #{error_message}"
+              end
+            end
+          end
+
+      end
+
+    end
+  end
+end

data/lib/elibri_api_client/api_adapters/v1_helpers.rb

@@ -0,0 +1,90 @@
+
+# Klasy pomocnicze dla API w wersji 1
+module Elibri
+  class ApiClient
+    module ApiAdapters
+      class V1
+
+        class UnknownError < RuntimeError; end
+        class Unauthorized < RuntimeError; end
+        class NotFound < RuntimeError; end
+        class Forbidden < RuntimeError; end
+        class ServerError < RuntimeError; end
+        class NoPendingData < RuntimeError; end
+        class NoRecentlyPickedUpQueues < RuntimeError; end
+        class QueueDoesNotExists < RuntimeError; end
+        class InvalidPageNumber < RuntimeError; end
+
+        # Klasy wyjątków rzucanych, gdy elibri zwróci określony błąd. Np. gdy dostaniemy:
+        #   <error id="1001">
+        #     <message>Queue does not exist</message>
+        #   </error>
+        # Biblioteka rzuca wyjątkiem QueueDoesNotExists.
+        EXCEPTION_CLASSES = {
+          '404' => NotFound,
+          '403' => Forbidden,
+          '500' => ServerError,
+          '1001' => QueueDoesNotExists,
+          '1002' => NoPendingData,
+          '1003' => NoRecentlyPickedUpQueues,
+          '1004' => InvalidPageNumber
+        }.freeze
+
+
+        # Zamiast rzeźbić ciągle w XML`u, tworzymy instancje kolejek.
+        class Queue
+
+          attr_reader :name, :items_total, :picked_up_at, :last_insert_at, :queue_id, :url
+
+          def initialize(api_adapter, attributes = {})
+            @api_adapter = api_adapter
+            @name = attributes[:name]
+            @items_total = attributes[:items_total].to_i
+            @queue_id = attributes[:queue_id]
+            @url = attributes[:url]
+
+            @last_insert_at = Time.parse(attributes[:last_insert_at]) if attributes[:last_insert_at].present?
+            @picked_up_at = Time.parse(attributes[:picked_up_at]) if attributes[:picked_up_at].present?
+          end
+
+
+          # Przekonwertuj kolejkę z danymi oczekującymi (np. 'pending_meta') na kolejkę nazwaną.
+          def pick_up!
+            @api_adapter.pick_up_queue!(self) unless picked_up?
+          end
+
+
+          # Hermetyzujemy stronicowanie danych. Programistę interesują tylko kolejne rekordy <Product>
+          def each_product(&block)
+            @api_adapter.each_product(self, &block)
+          end
+
+
+          # Czy to jest kolejka nazwana, czy oczekująca? Wszystkie kolejki z danymi oczekującymi mają w nazwie
+          # przedrostek 'pending_'. Np. 'pending_meta', 'pending_stocks'.
+          def picked_up?
+            !self.name.start_with?('pending_')
+          end
+
+
+          # Zbuduj instancję kolejki na podstawie XML`a.
+          def self.build_from_xml(api_adapter, queue_xml)
+            queue_xml = Nokogiri::XML(queue_xml).css('queue').first if queue_xml.is_a? String
+            Queue.new(api_adapter,
+              :name => queue_xml['name'],
+              :items_total => queue_xml['items_total'].to_i,
+              :last_insert_at => queue_xml['last_insert_at'],
+              :url => queue_xml['url'],
+              :queue_id => queue_xml['id'],
+              :picked_up_at => queue_xml['picked_up_at']
+            )
+          end
+          
+
+        end
+
+
+      end
+    end
+  end
+end

data/lib/elibri_api_client/api_adapters.rb

@@ -0,0 +1,16 @@
+
+require 'elibri_api_client/api_adapters/v1'
+
+module Elibri
+  class ApiClient
+
+    # Moduł zawierający adaptery dla poszczególnych wersji API. Dzięki takiej architekturze
+    # dodanie kolejnej wersji API sprowadza się do utworzenia nowej klasy w tym module, np.
+    # Elibri::ApiClient::ApiAdapters::V3
+    module ApiAdapters
+
+
+    end
+
+  end
+end

data/lib/elibri_api_client/core_extensions.rb

@@ -0,0 +1,60 @@
+
+
+# HTTParty ma parsować XML za pomocą Nokogiri. CRACK jest zbyt prosty do naszych zastosowań.
+module HTTParty
+  class Parser
+
+    def xml
+      @parsed_xml ||= Nokogiri::XML(body)
+    end
+
+  end
+end
+
+
+# Ukradzione z ActiveSupport:
+class Object
+  def blank?
+    respond_to?(:empty?) ? empty? : !self
+  end
+
+  def present?
+    !blank?
+  end
+
+  def presence
+    self if present?
+  end
+end
+
+class NilClass
+  def blank?
+    true
+  end
+end
+
+class FalseClass
+  def blank?
+    true
+  end
+end
+
+class TrueClass
+  def blank?
+    false
+  end
+end
+
+
+class String
+  def blank?
+    self !~ /\S/
+  end
+end
+
+
+class Numeric #:nodoc:
+  def blank?
+    false
+  end
+end

data/lib/elibri_api_client/version.rb

@@ -0,0 +1,13 @@
+
+module Elibri
+  class ApiClient
+    module Version
+      MAJOR = 1
+      MINOR = 0
+      PATCH = 1
+
+      STRING = [MAJOR, MINOR, PATCH].compact.join('.')
+    end
+
+  end
+end

data/lib/elibri_api_client.rb

@@ -0,0 +1,35 @@
+
+require 'time'
+require 'httparty'
+require 'nokogiri'
+require 'forwardable'
+require 'elibri_api_client/core_extensions'
+require 'elibri_api_client/version'
+require 'elibri_api_client/api_adapters'
+
+module Elibri
+  class ApiClient
+    extend Forwardable
+
+    DEFAULT_API_HOST_URI = 'http://api.elibri.com.pl:80'
+    attr_reader :host_uri
+
+
+    def initialize(options = {})
+      @login = options[:login]
+      @password = options[:password]
+      @host_uri = options[:host_uri] || DEFAULT_API_HOST_URI
+
+      # W przyszłości mogą być nowe wersje API, więc zostawiamy sobie furtkę w postaci adapterów:
+      api_version_str = options[:api_version] || 'v1'
+      adapter_class = Elibri::ApiClient::ApiAdapters.const_get(api_version_str.upcase) # Elibri::ApiClient::ApiAdapters::V1
+      @api_adapter = adapter_class.new(@host_uri, @login, @password)
+    end
+
+
+    # Metody API delegujemy do odpowiedniego adaptera:
+    def_delegators :@api_adapter,
+      :refill_all_queues!, :pending_data?, :pending_queues, :pick_up_queue!, :last_pickups, :each_product, :each_page
+
+  end
+end

data/test/elibri_api_client_test.rb

@@ -0,0 +1,50 @@
+require 'helper'
+
+
+# Testowy adapter
+module Elibri
+  class ApiClient
+    module ApiAdapters
+      # Testowy adapter.
+      class V999
+        def initialize(host_uri, login, password)
+        end
+      end
+    end
+  end
+end
+
+
+describe Elibri::ApiClient do
+
+  it "should be able to establish its version" do
+    assert_match /\d+\.\d+\.\d+/, Elibri::ApiClient::Version::STRING
+  end
+
+
+  it "should take some defaults in constructor" do
+    client = Elibri::ApiClient.new(:login => 'elibri_login', :password => 'pass')
+    assert_equal Elibri::ApiClient::DEFAULT_API_HOST_URI, client.host_uri
+
+    client = Elibri::ApiClient.new(:login => 'elibri_login', :password => 'pass', :host_uri => 'http://localhost:3000')
+    assert_equal 'http://localhost:3000', client.host_uri
+  end
+
+
+  it "should enable user to pick a version of API" do
+    client = Elibri::ApiClient.new(:login => 'elibri_login', :password => 'pass', :api_version => 'v999')
+    assert_kind_of Elibri::ApiClient::ApiAdapters::V999, client.instance_variable_get('@api_adapter')
+  end
+  
+  
+  it "should delegate several methods to apropriate API adapter" do
+    client = Elibri::ApiClient.new(:login => 'elibri_login', :password => 'pass')
+
+    delegated_methods = %w{refill_all_queues! pending_data? pending_queues pick_up_queue! last_pickups each_product each_page}
+    delegated_methods.each {|method_name| client.instance_variable_get('@api_adapter').expects(method_name) }
+    delegated_methods.each {|method_name| client.send(method_name) }
+  end
+  
+
+end
+

data/test/elibri_api_v1_adapter_queue_test.rb

@@ -0,0 +1,86 @@
+require 'helper'
+
+
+describe Elibri::ApiClient::ApiAdapters::V1::Queue do
+
+  before do
+    @api_adapter = mock('api_adapter')
+  end
+
+
+  it "should have several attributes" do
+    time = Time.now
+    queue = Elibri::ApiClient::ApiAdapters::V1::Queue.new(@api_adapter,
+      :name => 'meta',
+      :items_total => 120,
+      :queue_id => '192f134e666df34464bcc14d0413',
+      :url => 'http://api.elibri.com.pl/api/v1/queues/meta/192f134e666df34464bcc14d0413',
+      :last_insert_at => time.to_s,
+      :picked_up_at => time.to_s
+    )
+
+    assert_equal 'meta', queue.name 
+    assert_equal 120, queue.items_total
+    assert_equal '192f134e666df34464bcc14d0413', queue.queue_id
+    assert_equal 'http://api.elibri.com.pl/api/v1/queues/meta/192f134e666df34464bcc14d0413', queue.url
+    assert_equal time.to_i, queue.last_insert_at.to_i
+    assert_equal time.to_i, queue.picked_up_at.to_i
+  end
+  
+
+
+  it "should be able to build itself from provided XML" do
+    xml = %Q{<queue name="stocks" id="192f134e666df34464bcc14d04135cda2bd13a0c" url="http://api.elibri.com.pl/api/v1/queues/stocks/192f134e666df34464bcc14d04135cda2bd13a0c" items_total="1500" last_insert_at="2011-02-05 21:02:22 UTC" picked_up_at="2011-02-05 22:02:22 UTC"/>}
+
+    queue = Elibri::ApiClient::ApiAdapters::V1::Queue.build_from_xml(@api_adapter, xml)
+    assert_equal 'stocks', queue.name 
+    assert_equal 1500, queue.items_total
+    assert_equal '192f134e666df34464bcc14d04135cda2bd13a0c', queue.queue_id
+    assert_equal 'http://api.elibri.com.pl/api/v1/queues/stocks/192f134e666df34464bcc14d04135cda2bd13a0c', queue.url
+    assert_equal Time.parse("2011-02-05 21:02:22 UTC"), queue.last_insert_at 
+    assert_equal Time.parse("2011-02-05 22:02:22 UTC"), queue.picked_up_at
+
+    xml = %Q{<queue name="pending_stocks" items_total="1500" last_insert_at="2011-02-05 21:02:22 UTC"/>}
+    queue = Elibri::ApiClient::ApiAdapters::V1::Queue.build_from_xml(@api_adapter, xml)
+    assert_nil queue.queue_id
+    assert_nil queue.picked_up_at
+    assert_nil queue.url
+  end
+  
+
+  it "should be able to establish if its a picked up queue" do
+    queue = Elibri::ApiClient::ApiAdapters::V1::Queue.new(@api_adapter, :name => 'pending_meta')
+    assert !queue.picked_up?
+
+    queue = Elibri::ApiClient::ApiAdapters::V1::Queue.new(@api_adapter, :name => 'meta')
+    assert queue.picked_up?
+  end
+  
+  
+  
+  
+  it "should be able to pick up itself when its a pending queue" do
+    queue = Elibri::ApiClient::ApiAdapters::V1::Queue.new(@api_adapter, :name => 'pending_meta')
+    @api_adapter.expects(:pick_up_queue!).with(queue)
+    queue.pick_up!
+    
+    queue = Elibri::ApiClient::ApiAdapters::V1::Queue.new(@api_adapter, :name => 'meta')
+    @api_adapter.expects(:pick_up_queue!).with(queue).never
+    queue.pick_up!
+  end
+  
+  
+
+  it "should provide iterator for traversing products list" do
+    block = lambda {|product_xml| product_xml.css('RecordReference')  }
+
+    queue = Elibri::ApiClient::ApiAdapters::V1::Queue.new(@api_adapter, :name => 'meta')
+    @api_adapter.expects(:each_product).with(queue)
+    queue.each_product(&block)
+  end
+  
+  
+
+
+
+end

data/test/elibri_api_v1_adapter_test.rb

@@ -0,0 +1,309 @@
+require 'helper'
+
+
+describe Elibri::ApiClient::ApiAdapters::V1 do
+
+  FAKE_API_HOST = 'http://localhost:5000'
+
+  def get_request_expected(request_uri)
+    Elibri::ApiClient::ApiAdapters::V1.expects(:get).with(
+      request_uri,
+      {:digest_auth => {:username => 'login', :password => 'password'}}
+    )
+  end
+
+
+  def post_request_expected(request_uri)
+    Elibri::ApiClient::ApiAdapters::V1.expects(:post).with(
+      request_uri,
+      {:body => ' ', :digest_auth => {:username => 'login', :password => 'password'}}
+    )
+  end
+
+
+  before do
+    @adapter = Elibri::ApiClient::ApiAdapters::V1.new(FAKE_API_HOST, 'login', 'password')
+  end
+
+
+  it "should define several exception classes" do
+    exception_classes = %w{Unauthorized NotFound Forbidden ServerError NoPendingData NoRecentlyPickedUpQueues QueueDoesNotExists InvalidPageNumber}
+    exception_classes.each do |exception_class|
+      assert(Elibri::ApiClient::ApiAdapters::V1.const_get(exception_class) < RuntimeError)
+    end  
+  end
+  
+
+  it "should be able to refill all pending queues" do
+    response_stub = stub('response_stub', :code => 200, :parsed_response => nil)
+    post_request_expected("#{FAKE_API_HOST}/api/v1/queues/refill_all").returns(response_stub)
+
+    @adapter.refill_all_queues!
+  end
+  
+
+  describe "when asked to establish pending queues list" do
+
+    describe "and there is pending data awaiting for pull" do
+      before do
+        xml = <<-XML
+          <pending_data>
+            <queue name="pending_meta" items_total="24" last_insert_at="2011-02-05 21:02:22 UTC"/>      
+            <queue name="pending_stocks" items_total="1500" last_insert_at="2011-02-05 21:02:22 UTC"/>         
+          </pending_data>
+        XML
+
+        response_stub = stub('response_stub', :code => 200, :parsed_response => Nokogiri::XML(xml))
+        get_request_expected("#{FAKE_API_HOST}/api/v1/queues/pending_data").at_least_once.returns(response_stub)
+      end
+
+
+      it "should return Queue instances with attributes filled from returned XML" do
+        assert @adapter.pending_data?
+        pending_queues = @adapter.pending_queues
+        assert_equal 2, pending_queues.size
+
+        pending_meta = pending_queues.find {|queue| queue.name == 'pending_meta' }
+        pending_stocks = pending_queues.find {|queue| queue.name == 'pending_stocks' }
+
+        assert_equal 24, pending_meta.items_total
+        assert_kind_of Time, pending_meta.last_insert_at 
+
+        assert_equal 1500, pending_stocks.items_total
+        assert_kind_of Time, pending_stocks.last_insert_at 
+      end
+    end
+
+
+    describe "and there is no pending data awaiting for pull" do
+      before do
+        xml = <<-XML
+          <pending_data>
+            <queue name="pending_meta" items_total="0" />      
+            <queue name="pending_stocks" items_total="0" />         
+          </pending_data>
+        XML
+
+        response_stub = stub('response_stub', :code => 200, :parsed_response => Nokogiri::XML(xml))
+        get_request_expected("#{FAKE_API_HOST}/api/v1/queues/pending_data").at_least_once.returns(response_stub)
+      end
+
+
+      it "should return empty array and claim that there is no pending data" do
+        assert @adapter.pending_queues.empty?
+        assert !@adapter.pending_data?
+      end
+    end
+  end
+  
+  
+  describe "when asked to pick up queue" do
+    before do
+      xml = <<-XML
+        <pick_up>
+          <queue name="meta" id="192f134e666df34464bcc14d04135cda2bd13a0c" url="#{FAKE_API_HOST}/api/v1/queues/meta/192f134e666df34464bcc14d04135cda2bd13a0c" items_total="24" last_insert_at="2011-02-05 21:02:22 UTC" picked_up_at="2011-02-05 21:02:22 UTC"/>      
+        </pick_up>
+      XML
+
+      @response_stub = stub('response_stub', :code => 200, :parsed_response => Nokogiri::XML(xml))
+    end
+
+
+    it "should be able to pick it up by name" do
+      post_request_expected("#{FAKE_API_HOST}/api/v1/queues/pending_meta/pick_up").at_least_once.returns(@response_stub)
+      picked_up_queue = @adapter.pick_up_queue!('pending_meta')
+      assert_equal 24, picked_up_queue.items_total
+      assert_kind_of Time, picked_up_queue.picked_up_at
+    end
+    
+    
+    it "should be able to pick it up by Queue instance" do
+      post_request_expected("#{FAKE_API_HOST}/api/v1/queues/pending_meta/pick_up").at_least_once.returns(@response_stub)
+      queue_to_pick_up = Elibri::ApiClient::ApiAdapters::V1::Queue.new(@api_adapter, :name => 'pending_meta')
+      picked_up_queue = @adapter.pick_up_queue!(queue_to_pick_up)
+      assert_equal 24, picked_up_queue.items_total
+      assert_kind_of Time, picked_up_queue.picked_up_at
+    end
+
+
+    it "should raise error when cannot infer queue name from argument" do
+      post_request_expected("#{FAKE_API_HOST}/api/v1/queues/pending_meta/pick_up").never
+      post_request_expected("#{FAKE_API_HOST}/api/v1/queues/pending_stocks/pick_up").never
+
+      assert_raises(RuntimeError) { @adapter.pick_up_queue!(12345) }
+      assert_raises(RuntimeError) { @adapter.pick_up_queue!(Array.new) }
+    end
+  end
+  
+
+  it "should normalise request URI before performing real request" do
+    response_stub = stub('response_stub', :code => 200, :parsed_response => nil)
+
+    get_request_expected("#{FAKE_API_HOST}/api/v1/queues/meta/192f134e666df34464bcc14d0413").once.returns(response_stub)
+    @adapter.send(:get, "#{FAKE_API_HOST}/api/v1/queues/meta/192f134e666df34464bcc14d0413")
+
+    get_request_expected("#{FAKE_API_HOST}/api/v1/api_entrypoint").once.returns(response_stub)
+    @adapter.send(:get, '/api_entrypoint')
+
+    get_request_expected("#{FAKE_API_HOST}/api/v1/api_entrypoint_without_leading_slash").once.returns(response_stub)
+    @adapter.send(:get, 'api_entrypoint_without_leading_slash')
+  end
+  
+  
+  describe "when there was error reported" do
+    before do
+      @xml = %q{<error id="ERROR_CODE"> <message>Error message for error ERROR_CODE</message> </error>}
+      @exception_classes = {
+        '404' =>  Elibri::ApiClient::ApiAdapters::V1::NotFound,
+        '403' =>  Elibri::ApiClient::ApiAdapters::V1::Forbidden,
+        '500' =>  Elibri::ApiClient::ApiAdapters::V1::ServerError,
+        '1001' => Elibri::ApiClient::ApiAdapters::V1::QueueDoesNotExists,
+        '1002' => Elibri::ApiClient::ApiAdapters::V1::NoPendingData,
+        '1003' => Elibri::ApiClient::ApiAdapters::V1::NoRecentlyPickedUpQueues,
+        '1004' => Elibri::ApiClient::ApiAdapters::V1::InvalidPageNumber
+      }
+    end
+
+
+    it "should raise proper exception class" do
+      @exception_classes.each do |error_code, exception_class|
+        response_stub = stub('response_stub', :code => 200, :parsed_response => Nokogiri::XML( @xml.gsub('ERROR_CODE', error_code) ))
+        get_request_expected("#{FAKE_API_HOST}/api/v1/queues/pending_data").once.returns(response_stub)
+        assert_raises(exception_class) { @adapter.pending_queues }
+      end  
+    end
+
+
+    it "should raise Unauthorized, when there is 401 response code" do
+      response_stub = stub('response_stub', :code => 401, :parsed_response => nil)
+      get_request_expected("#{FAKE_API_HOST}/api/v1/queues/pending_data").once.returns(response_stub)
+      assert_raises(Elibri::ApiClient::ApiAdapters::V1::Unauthorized) { @adapter.pending_queues }
+    end
+
+
+    it "should raise RuntimeError on unknown error code" do
+      response_stub = stub('response_stub', :code => 200, :parsed_response => Nokogiri::XML( @xml.gsub('ERROR_CODE', 'UNKNOWN_ERROR_CODE') ))
+      get_request_expected("#{FAKE_API_HOST}/api/v1/queues/pending_data").once.returns(response_stub)
+      assert_raises(Elibri::ApiClient::ApiAdapters::V1::UnknownError) { @adapter.pending_queues }
+    end
+    
+  end
+
+
+  describe "when asked to get latest pickups" do
+    describe "and there is no recently picked up queues" do
+      before do
+        xml = %q{<error id='1003'> <message>There is no recently picked up queue</message> </error>}
+        response_stub = stub('response_stub', :code => 412, :parsed_response => Nokogiri::XML(xml))
+        get_request_expected("#{FAKE_API_HOST}/api/v1/queues/meta/last_pick_up").once.returns(response_stub)
+        get_request_expected("#{FAKE_API_HOST}/api/v1/queues/stocks/last_pick_up").once.returns(response_stub)
+      end
+
+      it "should return empty latest pickups list" do
+        assert @adapter.last_pickups.empty?
+      end
+    end
+
+
+    describe "and there were recently picked up queues" do
+      before do
+        meta_xml = <<-XML
+          <pick_up>
+            <queue name="meta" id="192f134e666df34464bcc14d04135cda2bd13a0c" url="#{FAKE_API_HOST}/api/v1/queues/meta/192f134e666df34464bcc14d04135cda2bd13a0c" items_total="24" last_insert_at="2011-02-05 21:02:22 UTC" picked_up_at="2011-02-05 21:02:22 UTC"/>      
+          </pick_up>
+        XML
+
+        stocks_xml = <<-XML
+          <pick_up>
+            <queue name="stocks" id="192f134e666df34464bcc14d04135cda2bd13a0d" url="#{FAKE_API_HOST}/api/v1/queues/stocks/192f134e666df34464bcc14d04135cda2bd13a0d" items_total="50" last_insert_at="2011-02-05 21:02:22 UTC" picked_up_at="2011-02-05 21:02:22 UTC"/>      
+          </pick_up>
+        XML
+
+        meta_response_stub = stub('response_stub', :code => 200, :parsed_response => Nokogiri::XML(meta_xml))
+        stocks_response_stub = stub('response_stub', :code => 200, :parsed_response => Nokogiri::XML(stocks_xml))
+        get_request_expected("#{FAKE_API_HOST}/api/v1/queues/meta/last_pick_up").once.returns(meta_response_stub)
+        get_request_expected("#{FAKE_API_HOST}/api/v1/queues/stocks/last_pick_up").once.returns(stocks_response_stub)
+      end
+
+
+      it "should return latest pickups as Queue instances" do
+        last_pickups = @adapter.last_pickups
+        assert_equal 2, last_pickups.size 
+        assert(last_pickups.all? { |pickup| pickup.is_a? Elibri::ApiClient::ApiAdapters::V1::Queue })
+      end
+    end
+  end
+
+
+  describe "when asked to iterate by products" do
+
+    before do
+      @queue = Elibri::ApiClient::ApiAdapters::V1::Queue.new(@adapter, :name => 'meta', :queue_id => 'QUEUE_ID')
+
+      first_page_xml = <<-XML
+        <queue name="meta" id="QUEUE_ID" items_total="54" picked_up_at="2011-02-05 21:02:22 UTC">      
+          <items paginated="true">
+            <pages total="3" items_per_page="20" > 
+              <next_page page_no="2" url="#{FAKE_API_HOST}/api/v1/queues/meta/QUEUE_ID/2" />      
+              <current_page page_no="1" url="#{FAKE_API_HOST}/api/v1/queues/meta/QUEUE_ID" >
+                <content><Product>PRODUCT_FROM_PAGE_1</Product></content>
+              </current_page>
+            </pages>
+          </items>
+        </queue>
+      XML
+
+      second_page_xml = <<-XML
+        <queue name="meta" id="QUEUE_ID" items_total="54" picked_up_at="2011-02-05 21:02:22 UTC">      
+          <items paginated="true">
+            <pages total="3" items_per_page="20" > 
+              <previous_page page_no="1" url="#{FAKE_API_HOST}/api/v1/queues/meta/QUEUE_ID" />      
+              <next_page page_no="3" url="#{FAKE_API_HOST}/api/v1/queues/meta/QUEUE_ID/3" />      
+              <current_page page_no="2" url="#{FAKE_API_HOST}/api/v1/queues/meta/QUEUE_ID/2" >
+                <content><Product>PRODUCT_FROM_PAGE_2</Product></content>
+              </current_page>
+            </pages>
+          </items>
+        </queue>
+      XML
+
+      third_page_xml = <<-XML
+        <queue name="meta" id="QUEUE_ID" items_total="54" picked_up_at="2011-02-05 21:02:22 UTC">      
+          <items paginated="true">
+            <pages total="3" items_per_page="20" > 
+              <previous_page page_no="2" url="#{FAKE_API_HOST}/api/v1/queues/meta/QUEUE_ID/2" />      
+              <current_page page_no="3" url="#{FAKE_API_HOST}/api/v1/queues/meta/QUEUE_ID/3" >
+                <content><Product>PRODUCT_FROM_PAGE_3</Product></content>
+              </current_page>
+            </pages>
+          </items>
+        </queue>
+      XML
+
+      first_page_response_stub = stub('response1_stub', :code => 200, :parsed_response => Nokogiri::XML(first_page_xml))
+      second_page_response_stub = stub('response2_stub', :code => 200, :parsed_response => Nokogiri::XML(second_page_xml))
+      third_page_response_stub = stub('response3_stub', :code => 200, :parsed_response => Nokogiri::XML(third_page_xml))
+
+      get_request_expected("#{FAKE_API_HOST}/api/v1/queues/meta/QUEUE_ID").once.returns(first_page_response_stub)
+      get_request_expected("#{FAKE_API_HOST}/api/v1/queues/meta/QUEUE_ID/2").once.returns(second_page_response_stub)
+      get_request_expected("#{FAKE_API_HOST}/api/v1/queues/meta/QUEUE_ID/3").once.returns(third_page_response_stub)
+    end
+
+
+    it "should be able to iterate through page products" do
+      expected_content = %w{<Product>PRODUCT_FROM_PAGE_1</Product> <Product>PRODUCT_FROM_PAGE_2</Product> <Product>PRODUCT_FROM_PAGE_3</Product>}
+      @adapter.each_page(@queue) do |page_content, page_no|
+        assert_equal expected_content[page_no-1], page_content.children.to_s
+      end
+    end
+    
+
+    it "should be able to iterate through all product records" do
+      expected_records = %w{PRODUCT_FROM_PAGE_1 PRODUCT_FROM_PAGE_2 PRODUCT_FROM_PAGE_3}
+      @adapter.each_product(@queue) do |product_xml, product_no|
+        assert_equal expected_records[product_no-1], product_xml.text
+      end
+    end
+  end
+
+end

data/test/helper.rb

@@ -0,0 +1,21 @@
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'test/unit'
+require 'minitest/autorun'
+require 'mocha'
+require 'ruby-debug'
+Debugger.settings[:autoeval] = true rescue nil
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'elibri_api_client'
+
+class Test::Unit::TestCase
+end

metadata

@@ -0,0 +1,202 @@
+--- !ruby/object:Gem::Specification 
+name: elibri_api_client
+version: !ruby/object:Gem::Version 
+  hash: 21
+  prerelease: 
+  segments: 
+  - 1
+  - 0
+  - 1
+  version: 1.0.1
+platform: ruby
+authors: 
+- "Marcin Urba\xC5\x84ski"
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-07-06 00:00:00 +02:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  type: :runtime
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 19
+        segments: 
+        - 0
+        - 7
+        - 8
+        version: 0.7.8
+  name: httparty
+  version_requirements: *id001
+  prerelease: false
+- !ruby/object:Gem::Dependency 
+  type: :runtime
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 11
+        segments: 
+        - 1
+        - 4
+        - 6
+        version: 1.4.6
+  name: nokogiri
+  version_requirements: *id002
+  prerelease: false
+- !ruby/object:Gem::Dependency 
+  type: :development
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  name: ruby-debug
+  version_requirements: *id003
+  prerelease: false
+- !ruby/object:Gem::Dependency 
+  type: :development
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  name: mocha
+  version_requirements: *id004
+  prerelease: false
+- !ruby/object:Gem::Dependency 
+  type: :development
+  requirement: &id005 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  name: minitest
+  version_requirements: *id005
+  prerelease: false
+- !ruby/object:Gem::Dependency 
+  type: :development
+  requirement: &id006 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 23
+        segments: 
+        - 1
+        - 0
+        - 0
+        version: 1.0.0
+  name: bundler
+  version_requirements: *id006
+  prerelease: false
+- !ruby/object:Gem::Dependency 
+  type: :development
+  requirement: &id007 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 11
+        segments: 
+        - 1
+        - 6
+        - 2
+        version: 1.6.2
+  name: jeweler
+  version_requirements: *id007
+  prerelease: false
+- !ruby/object:Gem::Dependency 
+  type: :development
+  requirement: &id008 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  name: rcov
+  version_requirements: *id008
+  prerelease: false
+description: API client for elibri.com.pl publishing system
+email: marcin@urbanski.vdl.pl
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE.txt
+- README.rdoc
+files: 
+- .document
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.rdoc
+- Rakefile
+- lib/elibri_api_client.rb
+- lib/elibri_api_client/api_adapters.rb
+- lib/elibri_api_client/api_adapters/v1.rb
+- lib/elibri_api_client/api_adapters/v1_helpers.rb
+- lib/elibri_api_client/core_extensions.rb
+- lib/elibri_api_client/version.rb
+- test/elibri_api_client_test.rb
+- test/elibri_api_v1_adapter_queue_test.rb
+- test/elibri_api_v1_adapter_test.rb
+- test/helper.rb
+has_rdoc: true
+homepage: http://github.com/elibri/elibri_api_client
+licenses: 
+- MIT
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.6.2
+signing_key: 
+specification_version: 3
+summary: API client for elibri.com.pl publishing system
+test_files: []
+