dopis_online_client 0.1.0 → 0.2.0

data/.gitignore

@@ -0,0 +1,6 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*
+rdoc/
+coverage/

data/Gemfile

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

data/README.rdoc

@@ -8,8 +8,8 @@ Vice informaci na https://online.postservis.cz/Download/DopisOnline/DopisOnline.
 
     require 'lib/dopis_online_client'
 
-    DopisOnlineClient::Request.base_uri 'http://localhost:8000'    
-    DopisOnlineClient::Request.auth('jmeno','heslo')
+    DopisOnlineClient.base_uri 'https://online.postservis.cz/cmdedopis'
+    DopisOnlineClient.auth('jmeno','heslo')
     
     DopisOnlineClient::Request.send(
       :pdf_file_path=>"letter.pdf"

data/Rakefile

@@ -1,65 +1,53 @@
-require 'rubygems'
-require 'rake'
+require 'bundler'
+Bundler::GemHelper.install_tasks
 
-begin
-  require 'jeweler'
-  Jeweler::Tasks.new do |gem|
-    gem.name = "dopis_online_client"
-    gem.summary = %Q{Dopis Online Client Library}
-    gem.email = "jiri.kubicek@kraxnet.cz"
-    gem.homepage = "http://github.com/kraxnet/dopis_online_client"
-    gem.authors = ["Jiri Kubicek"]
-    gem.description = "Klientská knihovna pro práci se službou Dopis Online České pošty"
-    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
-  end
-
-rescue LoadError
-  puts "Jeweler (or a dependency) not available. Install it with: sudo gem install jeweler"
-end
+task :default => :test
 
 require 'rake/testtask'
 Rake::TestTask.new(:test) do |test|
   test.libs << 'lib' << 'test'
-  test.pattern = 'test/**/*_test.rb'
+  test.test_files = FileList['test/unit/*_test.rb', 'test/integration/*_test.rb']
   test.verbose = true
+  # test.warning = true
 end
 
-begin
-  require 'rcov/rcovtask'
-  Rcov::RcovTask.new do |test|
-    test.libs << 'test'
-    test.pattern = 'test/**/*_test.rb'
+namespace :test do
+  Rake::TestTask.new(:unit) do |test|
+    test.libs << 'lib' << 'test'
+    test.pattern = 'test/unit/*_test.rb'
     test.verbose = true
   end
-rescue LoadError
-  task :rcov do
-    abort "RCov is not available. In order to run rcov, you must: sudo gem install spicycode-rcov"
+  Rake::TestTask.new(:integration) do |test|
+    test.libs << 'lib' << 'test'
+    test.pattern = 'test/integration/*_test.rb'
+    test.verbose = true
   end
 end
 
+# Generate documentation
 begin
-  require 'cucumber/rake/task'
-  Cucumber::Rake::Task.new(:features)
+  require 'sdoc'
 rescue LoadError
-  task :features do
-    abort "Cucumber is not available. In order to run features, you must: sudo gem install cucumber"
-  end
 end
-
-task :default => :test
-
 require 'rake/rdoctask'
 Rake::RDocTask.new do |rdoc|
-  if File.exist?('VERSION.yml')
-    config = YAML.load(File.read('VERSION.yml'))
-    version = "#{config[:major]}.#{config[:minor]}.#{config[:patch]}"
-  else
-    version = ""
-  end
-
   rdoc.rdoc_dir = 'rdoc'
-  rdoc.title = "frest_client #{version}"
-  rdoc.rdoc_files.include('README*')
+  rdoc.title = "Tire"
+  rdoc.rdoc_files.include('README.rdoc')
   rdoc.rdoc_files.include('lib/**/*.rb')
 end
 
+# Generate coverage reports
+begin
+  require 'rcov/rcovtask'
+  Rcov::RcovTask.new do |test|
+    test.libs << 'test'
+    test.rcov_opts = ['--exclude', 'gems/*']
+    test.pattern = 'test/**/*_test.rb'
+    test.verbose = true
+  end
+rescue LoadError
+  task :rcov do
+    abort "RCov is not available. In order to run rcov, you must: sudo gem install rcov"
+  end
+end

data/dopis_online_client.gemspec

@@ -0,0 +1,36 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+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}
+
+  s.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"]
+
+  s.extra_rdoc_files  = [ "README.rdoc", "LICENSE" ]
+  s.rdoc_options      = [ "--charset=UTF-8" ]
+
+  s.required_rubygems_version = ">= 1.3.6"
+
+  s.add_dependency "rake",        "~> 0.8.0"
+  s.add_dependency "bundler",     "~> 1.0.0"
+  s.add_dependency "httmultiparty"
+
+  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"
+end

data/lib/dopis_online_client/request.rb

@@ -1,33 +1,30 @@
-require 'httpclient'
-
 module DopisOnlineClient
   class Request
-    
+
+    include HTTMultiParty
+
     attr_reader :username, :password, :color, :postage_type, :payment_type, :response_format, :pdf_file
   
     def initialize(params)
-      @username = params[:username]
-      @password = params[:password]
       @color = params[:color] || 0 # cernobile
       @postage_type = params[:postage_type] || 66 # obycejne
       @payment_type = params[:payment_type] || 0 # fakturou
       @format = params[:format] || :xml
       @pdf_file_path = params[:pdf_file_path]
+      self.class.base_uri DopisOnlineClient.base_uri
     end
   
     def deliver
-      client = HTTPClient.new
-      client.ssl_config.verify_mode=OpenSSL::SSL::VERIFY_NONE
-      response = client.post @@base_uri, {
-        :user => @@username,
-        :passwd => @@password,
+      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)
       }
-      parsed_response = parse_response(response.body.content)
+      parsed_response = parse_response(response.body)
       DopisOnlineClient::Response.new(parsed_response, response.body, response.code)
     end
   
@@ -44,15 +41,6 @@ module DopisOnlineClient
     def self.send(params)
       @request = new(params).deliver
     end
-  
-    def self.base_uri(uri)
-      @@base_uri=uri
-    end
-  
-    def self.auth(username, password)
-      @@username=username
-      @@password=password
-    end
 
   end
 end

data/lib/dopis_online_client/response.rb

@@ -13,38 +13,50 @@ module DopisOnlineClient
       @delegate.send(name, *args, &block)
     end
 
+    # Byl dopis úspěšně přijat k odeslání?
     def success?
       code==200 && !has_key?("chyba") && has_key?("zakazka")
     end
 
+    # Jméno odeslaného souboru
     def filename
       success_result["soubor"]
     end
 
+    # Počet stránek
     def pages_count
       success_result["pocetstranek"].to_i
     end
 
+    # Kód objednávky
     def order_code
       success_result["kodobjednavky"].to_i
     end
 
+    # Podací číslo
     def tracking_number
       success_result["podacicislo"]
     end
 
+    # Datum podání
     def posting_date
       success_result["datumpodani"]
     end
 
+    # PSČ podací pošty
     def posting_zip
       success_result["podaciposta"]
     end
 
+    # Cena
     def price
       success_result["cena"]
     end
 
+    # Barva tisku
+    #
+    # * Barevný <tt>true</tt>
+    # * černobílý <tt>false</tt>
     def color
       success_result["barvatisku"]=="1"
     end
@@ -53,10 +65,12 @@ module DopisOnlineClient
       success_result["typvyplatneho"]
     end
 
+    # Popis chyby
     def failure_message
       failure_result["popis"]
     end
 
+    # Kód chyby
     def failure_code
       failure_result["kod"].to_i
     end

data/lib/dopis_online_client/status_request.rb

@@ -0,0 +1,27 @@
+module DopisOnlineClient
+  class StatusRequest
+
+    include HTTMultiParty
+
+    attr_reader :username, :password, :color, :postage_type, :payment_type, :response_format, :pdf_file
+  
+    def initialize(params)
+      @format = params[:format] || :xml
+      @tracking_number = params[:tracking_number]
+      @date = params[:date]
+      self.class.base_uri DopisOnlineClient.base_uri
+    end
+  
+    def deliver
+      response = self.class.post '/eprehledZak.php', :query => {
+        :user => DopisOnlineClient.username,
+        :passwd => DopisOnlineClient.password,
+        :typvystupu => @format,
+        :zasilka => @tracking_number,
+        :datum => @date
+      }
+      response.body
+    end
+
+  end
+end

data/lib/dopis_online_client/version.rb

@@ -0,0 +1,3 @@
+module DopisOnlineClient
+  VERSION = "0.2.0"
+end

data/lib/dopis_online_client.rb

@@ -1,12 +1,27 @@
-begin
-  require 'rubygems'
-  gem 'crack'
-  require 'crack'
-#  raise LoadError, "You must have crack installed"
-end
+require 'httmultiparty'
+
+require 'dopis_online_client/request'
+require 'dopis_online_client/response'
+require 'dopis_online_client/status_request'
 
 module DopisOnlineClient
+
+  def self.base_uri(path=nil)
+    path ? @base_uri = path : @base_uri
+  end
+
+  def self.auth(username, password)
+    @username=username
+    @password=password
+  end
+
+  def self.username
+    @username
+  end
+
+  def self.password
+    @password
+  end
+
 end
 
-require File.dirname(__FILE__) + '/dopis_online_client/request.rb'
-require File.dirname(__FILE__) + '/dopis_online_client/response.rb'

data/test/fixtures/status.xml

@@ -0,0 +1,35 @@
+<dopisonline>
+ <zakazka id="20110521067226">
+  <podacicislo type="string">neni</podacicislo>
+  <pocetstranek type="integer">1</pocetstranek>
+  <datumpodani type="datetime">2011-05-21 15:13:57</datumpodani>
+  <cena mena="CZK" type="decimal">12.60</cena>
+  <barvatisku type="integer">0</barvatisku>
+  <platba type="integer">0</platba>
+  <typvyplatneho type="integer">66</typvyplatneho>
+  <zpracovani type="integer">50</zpracovani>
+  <stav type="integer">0</stav>
+ </zakazka>
+ <zakazka id="20110521067227">
+  <podacicislo type="string">neni</podacicislo>
+  <pocetstranek type="integer">1</pocetstranek>
+  <datumpodani type="datetime">2011-05-21 15:14:25</datumpodani>
+  <cena mena="CZK" type="decimal">12.60</cena>
+  <barvatisku type="integer">0</barvatisku>
+  <platba type="integer">0</platba>
+  <typvyplatneho type="integer">66</typvyplatneho>
+  <zpracovani type="integer">50</zpracovani>
+  <stav type="integer">0</stav>
+ </zakazka>
+ <zakazka id="20110521067228">
+  <podacicislo type="string">neni</podacicislo>
+  <pocetstranek type="integer">1</pocetstranek>
+  <datumpodani type="datetime">2011-05-21 15:15:41</datumpodani>
+  <cena mena="CZK" type="decimal">12.60</cena>
+  <barvatisku type="integer">0</barvatisku>
+  <platba type="integer">0</platba>
+  <typvyplatneho type="integer">66</typvyplatneho>
+  <zpracovani type="integer">50</zpracovani>
+  <stav type="integer">0</stav>
+ </zakazka>
+</dopisonline>

data/test/test_helper.rb

@@ -1,11 +1,10 @@
 require 'rubygems'
 require 'test/unit'
 require 'shoulda'
-require 'matchy'
+require 'turn' unless ENV["TM_FILEPATH"]
 
-$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
-$LOAD_PATH.unshift(File.dirname(__FILE__))
 require 'dopis_online_client'
 
-class Test::Unit::TestCase
-end
+require "fakeweb"
+
+FakeWeb.allow_net_connect = false

data/test/unit/dopis_online_client_test.rb

@@ -0,0 +1,26 @@
+require 'test_helper'
+
+module DopisOnlineClient
+  class DopisOnlineClientTest < Test::Unit::TestCase
+
+    context "Client" do
+      setup do
+        DopisOnlineClient.base_uri 'http://mujdopisonline.cz/odeslat'
+        DopisOnlineClient.auth("mojejmeno", "mojeheslo")
+      end
+
+      should "have base_url set" do
+        assert_equal "http://mujdopisonline.cz/odeslat", DopisOnlineClient.base_uri
+      end
+
+      should "have username set" do
+        assert_equal "mojejmeno", DopisOnlineClient.username
+      end
+
+      should "have password set" do
+        assert_equal "mojeheslo", DopisOnlineClient.password
+      end
+    end
+
+  end
+end

data/test/unit/request_test.rb

@@ -0,0 +1,23 @@
+require 'test_helper'
+
+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')))
+
+        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
+      end
+
+      should "return DopisOnlineClient::Response" do
+        assert_equal true, @response.kind_of?(DopisOnlineClient::Response)
+      end
+
+    end
+
+  end
+end

data/test/unit/response_test.rb

@@ -0,0 +1,41 @@
+require 'test_helper'
+
+module DopisOnlineClient
+  class ResponseTest < Test::Unit::TestCase
+
+    should "parse success correctly" do
+      response = load_response_from_file("success.xml")
+
+      assert_equal 200,   response.code
+      assert_equal true,  response.success?
+
+      assert_equal 0,     response.failure_code
+      assert_nil          response.failure_message
+
+      assert_equal "testing.pdf",             response.filename
+      assert_equal 1,                         response.pages_count
+      assert_equal 20090608050001,            response.order_code
+      assert_equal "",                        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
+    end
+
+    should "parse failure correctly" do
+      response = load_response_from_file("failure.xml")
+
+      assert_equal 200,   response.code
+      assert_equal false, response.success?
+      assert_equal 8,     response.failure_code
+      assert_not_nil      response.failure_message
+    end
+
+    def load_response_from_file(filename)
+      body = File.read(File.join(File.dirname(__FILE__),'../fixtures',filename))
+      parsed_response = Crack::XML.parse(body)
+      DopisOnlineClient::Response.new(parsed_response, body, 200)
+    end
+
+  end
+end

data/test/unit/status_request_test.rb

@@ -0,0 +1,22 @@
+require 'test_helper'
+
+module DopisOnlineClient
+  class StatusRequestTest < Test::Unit::TestCase
+
+    context "Request#deliver" do
+
+      setup do
+        FakeWeb.register_uri(:post, "https://online3.postservis.cz/cmdedopis/eprehledZak.php", :body => File.read(File.join(File.dirname(__FILE__),'../fixtures/status.xml')))
+        DopisOnlineClient.base_uri 'https://online3.postservis.cz/cmdedopis'
+        DopisOnlineClient.auth('jmeno','heslo')
+        @response = DopisOnlineClient::StatusRequest.new(:date=>"20110521").deliver
+      end
+
+      should "return response" do
+        assert_not_nil @response
+      end
+
+    end
+
+  end
+end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: dopis_online_client
 version: !ruby/object:Gem::Version 
-  hash: 27
+  hash: 23
   prerelease: 
   segments: 
   - 0
-  - 1
+  - 2
   - 0
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors: 
 - Jiri Kubicek
@@ -15,31 +15,156 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-09-30 00:00:00 +02:00
+date: 2011-05-21 00:00:00 +02:00
 default_executable: 
-dependencies: []
-
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rake
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 63
+        segments: 
+        - 0
+        - 8
+        - 0
+        version: 0.8.0
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: bundler
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 23
+        segments: 
+        - 1
+        - 0
+        - 0
+        version: 1.0.0
+  type: :runtime
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: httmultiparty
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: turn
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id004
+- !ruby/object:Gem::Dependency 
+  name: shoulda
+  prerelease: false
+  requirement: &id005 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id005
+- !ruby/object:Gem::Dependency 
+  name: sdoc
+  prerelease: false
+  requirement: &id006 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id006
+- !ruby/object:Gem::Dependency 
+  name: rcov
+  prerelease: false
+  requirement: &id007 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id007
+- !ruby/object:Gem::Dependency 
+  name: fakeweb
+  prerelease: false
+  requirement: &id008 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id008
 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
+email: 
+- jiri.kubicek@kraxnet.cz
 executables: []
 
 extensions: []
 
 extra_rdoc_files: 
-- LICENSE
 - README.rdoc
+- LICENSE
 files: 
+- .gitignore
+- Gemfile
 - LICENSE
 - README.rdoc
 - Rakefile
-- VERSION
+- dopis_online_client.gemspec
 - lib/dopis_online_client.rb
 - lib/dopis_online_client/request.rb
 - lib/dopis_online_client/response.rb
-- test/dopis_online_response_test.rb
+- lib/dopis_online_client/status_request.rb
+- lib/dopis_online_client/version.rb
 - test/fixtures/failure.xml
+- test/fixtures/letter.pdf
+- test/fixtures/status.xml
 - test/fixtures/success.xml
 - test/test_helper.rb
+- test/unit/dopis_online_client_test.rb
+- test/unit/request_test.rb
+- test/unit/response_test.rb
+- test/unit/status_request_test.rb
 has_rdoc: true
 homepage: http://github.com/kraxnet/dopis_online_client
 licenses: []
@@ -63,17 +188,26 @@ required_rubygems_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: 3
+      hash: 23
       segments: 
-      - 0
-      version: "0"
+      - 1
+      - 3
+      - 6
+      version: 1.3.6
 requirements: []
 
-rubyforge_project: 
+rubyforge_project: dopis_online_client
 rubygems_version: 1.6.2
 signing_key: 
 specification_version: 3
 summary: Dopis Online Client Library
 test_files: 
-- test/dopis_online_response_test.rb
+- test/fixtures/failure.xml
+- test/fixtures/letter.pdf
+- test/fixtures/status.xml
+- test/fixtures/success.xml
 - test/test_helper.rb
+- test/unit/dopis_online_client_test.rb
+- test/unit/request_test.rb
+- test/unit/response_test.rb
+- test/unit/status_request_test.rb

data/VERSION

@@ -1 +0,0 @@
-0.1.0

data/test/dopis_online_response_test.rb

@@ -1,38 +0,0 @@
-require 'test_helper'
-
-class DopisOnlineResponseTest < Test::Unit::TestCase
-  
-  should "parse success correctly" do
-    response = load_response_from_file("success.xml")
-    
-    response.code.should == 200
-    response.success?.should == true
-    
-    response.failure_code.should == 0
-    response.failure_message.should == nil
-    
-    response.filename.should == "testing.pdf"
-    response.pages_count.should == 1
-    response.order_code.should == 20090608050001
-    response.tracking_number.should == ""
-    response.datumpodani.should == Date.parse("2009-06-08")
-    response.price.should_not == nil
-    response.color.should == false
-    response.shipping_method.should == 67
-  end
-
-  should "parse failure correctly" do
-    response = load_response_from_file("failure.xml")
-
-    response.code.should == 200
-    response.success?.should == false
-    response.failure_code.should == 8
-    response.failure_message.should_not == nil
-  end
-
-  def load_response_from_file(filename)
-    body = File.read(File.join(File.dirname(__FILE__),'fixtures',filename))
-    parsed_response = Crack::XML.parse(body)
-    DopisOnlineClient::Response.new(parsed_response, body, 200)
-  end
-end