dopis_online_client 0.2.4 → 1.0.1

data/.travis.yml

@@ -0,0 +1,5 @@
+language: ruby
+rvm:
+  - 1.9.3
+  - 2.0.0
+script: bundle exec rake test

data/Gemfile

@@ -1,4 +1,4 @@
-source "http://rubygems.org"
+source 'https://rubygems.org'
 
 # Specify your gem's dependencies in dopis_online_client.gemspec
 gemspec

data/LICENSE

@@ -1,4 +1,6 @@
-Copyright (c) 2009 Jiri Kubicek, KRAXNET s.r.o.
+Copyright (c) 2009 - 2013 Jiri Kubicek, KRAXNET s.r.o.
+
+MIT License
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/README.md

@@ -0,0 +1,20 @@
+# dopis_online_client
+
+[![Build Status](https://travis-ci.org/kraxnet/dopis_online_client.png)](https://travis-ci.org/kraxnet/dopis_online_client)
+
+DopisOnline je služba České pošty, s.p., která "umožnuje zákazníkovi podání dokumentu v elektronické formě (formát PDF), přičemž dodáná je uskutečněno formou klasického vytištěného dopisu."
+
+Vice informaci na https://online.postservis.cz/Download/DopisOnline/DopisOnline.pdf
+
+## Usage:
+
+    require 'lib/dopis_online_client'
+
+    DopisOnlineClient.base_uri 'https://online.postservis.cz/cmdedopis'
+    DopisOnlineClient.auth('jmeno','heslo')
+
+    DopisOnlineClient::Request.send("letter.pdf")
+
+## Copyright
+
+Copyright (c) 2009-2013 Jiří Kubíček, KRAXNET s.r.o.. See LICENSE for details.

data/Rakefile

@@ -1,5 +1,4 @@
-require 'bundler'
-Bundler::GemHelper.install_tasks
+require 'bundler/gem_tasks'
 
 task :default => :test
 
@@ -29,7 +28,7 @@ begin
   require 'sdoc'
 rescue LoadError
 end
-require 'rake/rdoctask'
+require 'rdoc/task'
 Rake::RDocTask.new do |rdoc|
   rdoc.rdoc_dir = 'rdoc'
   rdoc.title = "Tire"
@@ -50,4 +49,4 @@ rescue LoadError
   task :rcov do
     abort "RCov is not available. In order to run rcov, you must: sudo gem install rcov"
   end
-end
+end

data/dopis_online_client.gemspec

@@ -1,37 +1,39 @@
 # -*- encoding: utf-8 -*-
-$:.push File.expand_path("../lib", __FILE__)
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require "dopis_online_client/version"
 
-Gem::Specification.new do |s|
-  s.name        = "dopis_online_client"
-  s.version     = DopisOnlineClient::VERSION
-  s.platform    = Gem::Platform::RUBY
-  s.authors     = ["Jiri Kubicek"]
-  s.email       = ["jiri.kubicek@kraxnet.cz"]
-  s.homepage    = "http://github.com/kraxnet/dopis_online_client"
-  s.summary     = %q{Dopis Online Client Library}
-  s.description = %q{Klientská knihovna pro práci se službou Dopis Online České pošty}
+Gem::Specification.new do |gem|
+  gem.name        = "dopis_online_client"
+  gem.version     = DopisOnlineClient::VERSION
+  gem.platform    = Gem::Platform::RUBY
+  gem.authors     = ["Jiri Kubicek", "Josef Pospisil"]
+  gem.email       = ["jiri.kubicek@kraxnet.cz", "josef.pospisil@laststar.eu"]
+  gem.homepage    = "http://github.com/kraxnet/dopis_online_client"
+  gem.summary     = %q{Dopis Online Client Library}
+  gem.description = %q{Klientská knihovna pro práci se službou Dopis Online České pošty}
 
-  s.rubyforge_project = "dopis_online_client"
+  gem.rubyforge_project = "dopis_online_client"
 
-  s.files         = `git ls-files`.split("\n")
-  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
-  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
-  s.require_paths = ["lib"]
+  gem.files         = `git ls-files`.split($/)
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.require_paths = ["lib"]
 
-  s.extra_rdoc_files  = [ "README.rdoc", "LICENSE" ]
-  s.rdoc_options      = [ "--charset=UTF-8" ]
+  gem.extra_rdoc_files  = [ "README.md", "LICENSE" ]
+  gem.rdoc_options      = [ "--charset=UTF-8" ]
 
-  s.required_rubygems_version = ">= 1.3.6"
+  gem.required_rubygems_version = ">= 1.3.6"
 
-  s.add_dependency "rake",        ">= 0.8.0"
-  s.add_dependency "bundler",     ">= 1.0"
-  s.add_dependency "httmultiparty"
-  s.add_dependency "crack"
+  gem.add_dependency "rake",        ">= 0.8.0"
+  gem.add_dependency "bundler",     ">= 1.0"
+  gem.add_dependency "httmultiparty"
+  gem.add_dependency "multi_xml"
+  gem.add_dependency "builder"
 
-  s.add_development_dependency "turn"
-  s.add_development_dependency "shoulda"
-  s.add_development_dependency "sdoc"
-  s.add_development_dependency "rcov"
-  s.add_development_dependency "fakeweb"
+  gem.add_development_dependency "turn"
+  gem.add_development_dependency "shoulda"
+  gem.add_development_dependency "sdoc"
+  gem.add_development_dependency "simplecov"
+  gem.add_development_dependency "fakeweb"
 end

data/lib/dopis_online_client.rb

@@ -6,22 +6,38 @@ require 'dopis_online_client/status_request'
 
 module DopisOnlineClient
 
-  def self.base_uri(path=nil)
+  # Public: Sets the service uri
+  #
+  # uri - string with base uri of the service
+  #
+  def self.base_uri(path = nil)
     path ? @base_uri = path : @base_uri
   end
 
+  # Public: Sets authentication credentials
+  #
+  # username - string with username
+  # password - password
+  #
   def self.auth(username, password)
-    @username=username
-    @password=password
+    @username = username
+    @password = password
   end
 
+  # Public: Gets the current username
+  #
+  # Returns string with the username
+  #
   def self.username
     @username
   end
 
+  # Public: Gets the current password
+  #
+  # Returns string with the password
+  #
   def self.password
     @password
   end
-
 end
 

data/lib/dopis_online_client/request.rb

@@ -1,46 +1,120 @@
+require 'builder'
+require 'base64'
+require 'ostruct'
+
 module DopisOnlineClient
   class Request
 
     include HTTMultiParty
 
-    attr_reader :username, :password, :color, :postage_type, :payment_type, :response_format, :pdf_file
-  
-    def initialize(params)
-      @color = params[:color] || 0 # cernobile
-      @postage_type = params[:postage_type] || 195 # obycejne
-      @payment_type = params[:payment_type] || 0 # fakturou
-      @format = params[:format] || :xml
-      @pdf_file_path = params[:pdf_file_path]
+    DEFAULTS = {:postage_type => 195, # common
+                :coupon_type => 0, # do not print
+                :print_type => 0, # one-sided print
+                :sender_type => 2, # from 1st page of the document
+                :recipient_type => 2,
+                :format => :xml
+    }
+
+
+    attr_reader :pdf_file_path, :options
+
+    # Public: Sends the request to the service
+    #
+    # pdf_file_path - string with the path to the pdf file, that will be send
+    # params - hash with the additional parameters
+    #
+    # Returns new DopisOnlineClient::Response
+    #
+    def self.send(pdf_file_path, params = {})
+      @request = new(pdf_file_path, params).deliver
+    end
+
+    # Public: Initializes library
+    #
+    # pdf_file_path - string with the path to the pdf file, that will be send
+    # params - hash with the additional parameters
+    #
+    def initialize(pdf_file_path, params = {})
+      params.merge!(DEFAULTS)
+      @options = OpenStruct.new(params)
+      @pdf_file_path = pdf_file_path
       self.class.base_uri DopisOnlineClient.base_uri
     end
-  
+
+    # Public: Delivers payload to service
+    #
+    # Returns new DopisOnlineClient::Response
+    #
     def deliver
-      response = self.class.post '/dopisonline.php', :body => {
-        :user => DopisOnlineClient.username,
-        :passwd => DopisOnlineClient.password,
-        :barvatisku => @color,
-        :typvyplatneho => @postage_type,
-        :typuhrady => @payment_type,
-        :typvystupu => @format.to_s,
-        :soubor => File.new(@pdf_file_path)
-      }
+      response = self.class.post '/dopisonline/donApi.php', :body => body
       parsed_response = parse_response(response.body)
       DopisOnlineClient::Response.new(parsed_response, response.body, response.code)
     end
-  
+
+    # Internal: parses the body of the response
+    #
+    # body - string with service response
+    #
+    # Returns nil if the body is not present
+    #
     def parse_response(body)
       return nil if body.nil? or body.empty?
-      case @format
-        when :xml
-          Crack::XML.parse(body)
-        else
-          body
-        end
-    end
-  
-    def self.send(params)
-      @request = new(params).deliver
+      case options.format
+      when :xml
+        MultiXml.parse(body)
+      else
+        body
+      end
     end
 
+    # Internal: returns hash with request body
+    #
+    # Returns Hash with request body
+    #
+    def body
+      xml = Builder::XmlMarkup.new( :indent => 2 )
+      xml.instruct! :xml, :encoding => "UTF-8"
+      xml.dataroot do |dataroot|
+        dataroot.typvyplatneho options.postage_type
+        dataroot.typtisku options.print_type
+        dataroot.tiskpoukazky options.coupon_type
+        dataroot.typods options.sender_type
+        dataroot.typadr options.recipient_type
+        dataroot.odsid nil
+        dataroot.odsobrazek nil
+        dataroot.odsfirma nil
+        dataroot.odsosoba nil
+        dataroot.odsulice nil
+        dataroot.odscp nil
+        dataroot.odsco nil
+        dataroot.odsobec nil
+        dataroot.odspsc nil
+        dataroot.adrosloveni nil
+        dataroot.adrfirma nil
+        dataroot.adrosoba nil
+        dataroot.adrulice nil
+        dataroot.adrcp nil
+        dataroot.adrco nil
+        dataroot.adrobec nil
+        dataroot.adrpsc nil
+        dataroot.adriso nil
+        dataroot.soubory  do |soubory|
+          soubory.soubor(:mimeType => "", :name => @pdf_file_path.split("/").last) do |soubor|
+            soubor.dataSoubor Base64.encode64(File.read(@pdf_file_path))
+          end
+        end
+      end
+
+      xml_file = Tempfile.new(["DopisOnlineNew_1_1", ".xml"])
+      xml_file.write xml.target!
+      xml_file.flush
+      xml_file.rewind
+
+      {
+        :user => DopisOnlineClient.username,
+        :password => DopisOnlineClient.password,
+        :soubor => xml_file
+      }
+    end
   end
-end
+end

data/lib/dopis_online_client/response.rb

@@ -1,5 +1,3 @@
-require 'crack'
-
 module DopisOnlineClient
   class Response
     attr_accessor :body, :code
@@ -22,22 +20,22 @@ module DopisOnlineClient
 
     # Jméno odeslaného souboru
     def filename
-      success_result["soubor"]
+      success_result["soubory"]["soubor"]["name"]
     end
 
     # Počet stránek
     def pages_count
-      success_result["pocetstranek"].to_i
+      success_result["pocet_stranek"].to_i
     end
 
     # Kód objednávky
     def order_code
-      success_result["kodobjednavky"].to_i
+      success_result["kod_objednavky"]
     end
 
     # Podací číslo
     def tracking_number
-      success_result["podacicislo"]
+      success_result["podaci_cislo"]
     end
 
     # Datum podání

data/lib/dopis_online_client/version.rb

@@ -1,3 +1,3 @@
 module DopisOnlineClient
-  VERSION = "0.2.4"
+  VERSION = "1.0.1"
 end

data/test/fixtures/success.xml

@@ -1,12 +1,22 @@
-<?xml version="1.0" encoding="windows-1250"?>
+<?xml version="1.0" encoding="UTF-8"?>
 <zakazka>
-<soubor type="string">testing.pdf</soubor>
-<pocetstranek type="integer">1</pocetstranek>
-<kodobjednavky type="string">20090608050001</kodobjednavky>
-<podacicislo type="string"></podacicislo>
-<datumpodani type="date">2009-06-08</datumpodani>
-<podaciposta type="string">370 20</podaciposta>
-<cena mena="CZK" type="decimal">14.05</cena>
-<barvatisku type="integer">0</barvatisku>
-<typvyplatneho type="integer">67</typvyplatneho>
+  <chyby stav="0">
+  </chyby>
+  <typvyplatneho>195</typvyplatneho>
+  <typtisku>0</typtisku>
+  <tiskpoukazky>0</tiskpoukazky>
+  <kod_objednavky>20130717183959_77667</kod_objednavky>
+  <podaci_cislo></podaci_cislo>
+  <podaci_posta>370 20</podaci_posta>
+  <datum_podani>2013-07-17</datum_podani>
+  <cena>11.31 Kč</cena>
+  <pocet_listu>1</pocet_listu>
+  <pocet_stranek>1</pocet_stranek>
+  <xmlsoubor>DopisOnlineNew_1_120130717-84759-1z06ta5.xml</xmlsoubor>
+  <soubory>
+    <soubor name="1234.pdf">
+    <pozice>1</pozice>
+      <pocet_stranek>1</pocet_stranek>
+    </soubor>
+  </soubory>
 </zakazka>

data/test/test_helper.rb

@@ -3,8 +3,10 @@ require 'test/unit'
 require 'shoulda'
 require 'turn' unless ENV["TM_FILEPATH"]
 
-require 'dopis_online_client'
-
 require "fakeweb"
 
+$LOAD_PATH.unshift "lib"
+
+require 'dopis_online_client'
+
 FakeWeb.allow_net_connect = false

data/test/unit/dopis_online_client_test.rb

@@ -23,4 +23,4 @@ module DopisOnlineClient
     end
 
   end
-end
+end

data/test/unit/request_test.rb

@@ -4,20 +4,33 @@ module DopisOnlineClient
   class RequestTest < Test::Unit::TestCase
 
     context "Request#deliver" do
-
       setup do
-        FakeWeb.register_uri(:post, "https://online3.postservis.cz/cmdedopis/dopisonline.php", :body => File.read(File.join(File.dirname(__FILE__),'../fixtures/success.xml')))
+        FakeWeb.register_uri(:post, "https://online3.postservis.cz/dopisonline/donApi.php",
+                             :body => File.read(File.join(File.dirname(__FILE__), '../fixtures/success.xml')))
 
-        DopisOnlineClient.base_uri 'https://online3.postservis.cz/cmdedopis'
-        DopisOnlineClient.auth('jmeno','heslo')
-        @response = DopisOnlineClient::Request.new(:pdf_file_path=>File.join(File.dirname(__FILE__),'../fixtures/letter.pdf')).deliver
+        DopisOnlineClient.base_uri 'https://online3.postservis.cz/'
+        DopisOnlineClient.auth('jmeno', 'heslo')
+        @filename = File.join(File.dirname(__FILE__), '../fixtures/letter.pdf')
+        @request = DopisOnlineClient::Request.new(@filename)
       end
 
-      should "return DopisOnlineClient::Response" do
-        assert_equal true, @response.kind_of?(DopisOnlineClient::Response)
+      should "set default options for sending" do
+        assert_equal 195, @request.options.postage_type
+        assert_equal 0, @request.options.coupon_type
+        assert_equal 0, @request.options.print_type
+        assert_equal 2, @request.options.sender_type
+        assert_equal 2, @request.options.recipient_type
+        assert_equal :xml, @request.options.format
       end
 
-    end
+      should "set pdf_file_path" do
+        assert_equal @filename, @request.pdf_file_path
+      end
 
+      should "return DopisOnlineClient::Response" do
+        assert DopisOnlineClient::Response === @request.deliver
+      end
+    end
   end
 end
+

data/test/unit/response_test.rb

@@ -12,14 +12,14 @@ module DopisOnlineClient
       assert_equal 0,     response.failure_code
       assert_nil          response.failure_message
 
-      assert_equal "testing.pdf",             response.filename
+      assert_equal "1234.pdf",                response.filename
       assert_equal 1,                         response.pages_count
-      assert_equal 20090608050001,            response.order_code
-      assert_equal "",                        response.tracking_number
+      assert_equal "20130717183959_77667",    response.order_code
+      assert_equal nil,                       response.tracking_number
   #    assert_equal Date.parse("2009-06-08"),  response.success_result["datumpodani"]
       assert_not_nil                          response.price
       assert_equal false,                     response.color
-      assert_equal 67,                        response.shipping_method
+      assert_equal "195",                     response.shipping_method
     end
 
     should "parse failure correctly" do
@@ -33,7 +33,7 @@ module DopisOnlineClient
 
     def load_response_from_file(filename)
       body = File.read(File.join(File.dirname(__FILE__),'../fixtures',filename))
-      parsed_response = Crack::XML.parse(body)
+      parsed_response = MultiXml.parse(body)
       DopisOnlineClient::Response.new(parsed_response, body, 200)
     end
 

metadata

@@ -1,21 +1,22 @@
 --- !ruby/object:Gem::Specification 
 name: dopis_online_client
 version: !ruby/object:Gem::Version 
-  hash: 31
+  hash: 21
   prerelease: 
   segments: 
+  - 1
   - 0
-  - 2
-  - 4
-  version: 0.2.4
+  - 1
+  version: 1.0.1
 platform: ruby
 authors: 
 - Jiri Kubicek
+- Josef Pospisil
 autorequire: 
 bindir: bin
 cert_chain: []
 
-date: 2012-05-03 00:00:00 Z
+date: 2013-07-18 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: rake
@@ -63,7 +64,7 @@ dependencies:
   type: :runtime
   version_requirements: *id003
 - !ruby/object:Gem::Dependency 
-  name: crack
+  name: multi_xml
   prerelease: false
   requirement: &id004 !ruby/object:Gem::Requirement 
     none: false
@@ -77,7 +78,7 @@ dependencies:
   type: :runtime
   version_requirements: *id004
 - !ruby/object:Gem::Dependency 
-  name: turn
+  name: builder
   prerelease: false
   requirement: &id005 !ruby/object:Gem::Requirement 
     none: false
@@ -88,10 +89,10 @@ dependencies:
         segments: 
         - 0
         version: "0"
-  type: :development
+  type: :runtime
   version_requirements: *id005
 - !ruby/object:Gem::Dependency 
-  name: shoulda
+  name: turn
   prerelease: false
   requirement: &id006 !ruby/object:Gem::Requirement 
     none: false
@@ -105,7 +106,7 @@ dependencies:
   type: :development
   version_requirements: *id006
 - !ruby/object:Gem::Dependency 
-  name: sdoc
+  name: shoulda
   prerelease: false
   requirement: &id007 !ruby/object:Gem::Requirement 
     none: false
@@ -119,7 +120,7 @@ dependencies:
   type: :development
   version_requirements: *id007
 - !ruby/object:Gem::Dependency 
-  name: rcov
+  name: sdoc
   prerelease: false
   requirement: &id008 !ruby/object:Gem::Requirement 
     none: false
@@ -133,7 +134,7 @@ dependencies:
   type: :development
   version_requirements: *id008
 - !ruby/object:Gem::Dependency 
-  name: fakeweb
+  name: simplecov
   prerelease: false
   requirement: &id009 !ruby/object:Gem::Requirement 
     none: false
@@ -146,21 +147,37 @@ dependencies:
         version: "0"
   type: :development
   version_requirements: *id009
+- !ruby/object:Gem::Dependency 
+  name: fakeweb
+  prerelease: false
+  requirement: &id010 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id010
 description: "Klientsk\xC3\xA1 knihovna pro pr\xC3\xA1ci se slu\xC5\xBEbou Dopis Online \xC4\x8Cesk\xC3\xA9 po\xC5\xA1ty"
 email: 
 - jiri.kubicek@kraxnet.cz
+- josef.pospisil@laststar.eu
 executables: []
 
 extensions: []
 
 extra_rdoc_files: 
-- README.rdoc
+- README.md
 - LICENSE
 files: 
 - .gitignore
+- .travis.yml
 - Gemfile
 - LICENSE
-- README.rdoc
+- README.md
 - Rakefile
 - dopis_online_client.gemspec
 - lib/dopis_online_client.rb
@@ -222,3 +239,4 @@ test_files:
 - test/unit/request_test.rb
 - test/unit/response_test.rb
 - test/unit/status_request_test.rb
+has_rdoc: 

data/README.rdoc

@@ -1,20 +0,0 @@
-= dopis_online_client
-
-DopisOnline je sluzba Ceske posty, s.p., ktera "umoznuje zakaznikovi podani dokumentu v elektronické formě (formát PDF), přičemž dodání je uskutečněno formou klasického vytištěného dopisu."
-
-Vice informaci na https://online.postservis.cz/Download/DopisOnline/DopisOnline.pdf
-
-== Usage:
-
-    require 'lib/dopis_online_client'
-
-    DopisOnlineClient.base_uri 'https://online.postservis.cz/cmdedopis'
-    DopisOnlineClient.auth('jmeno','heslo')
-    
-    DopisOnlineClient::Request.send(
-      :pdf_file_path=>"letter.pdf"
-    )
-
-== Copyright
-
-Copyright (c) 2009 Jiri Kubicek, KRAXNET s.r.o.. See LICENSE for details.