onlinebrief24 1.0.0 → 1.0.2

data/README.md

@@ -2,7 +2,7 @@
 
 [![Build Status](https://travis-ci.org/rmoriz/onlinebrief24.png)](https://travis-ci.org/rmoriz/onlinebrief24)
 
-This gem is only interesting for users that use the German letter outbound service Onlinebrief24.de. This gem wraps the required workflow to upload a PDF to Onlinebrief24's servers. Onlinebrief24 then prints and mails the letters via snail mail. As this service is only available to German customers, the following documentation is available in German language only.
+This gem is only interesting for users that use the German letter outbound service <a href="http://www.onlinebrief24.de/">Onlinebrief24.de</a>. This gem wraps the required workflow to upload a PDF to Onlinebrief24's servers. Onlinebrief24 then prints and mails the letters via snail mail. As this service is only available to German customers, the following documentation is available in German language only.
 
 ## Voraussetzung
 
@@ -30,7 +30,7 @@ $ gem install onlinebrief24
 
 ## Beispiele
 
-#### Kurzform
+### Kurzform
 ```ruby
 require 'onlinebrief24'
 
@@ -43,6 +43,139 @@ c.upload! '/tmp/filename3.pdf', :registered => :standard,  :distribution => :int
 c.disconnect
 ```
 
+### Block
+
+```ruby
+require 'onlinebrief24'
+
+Onlinebrief24::Client.new(:login => 'email@example.com', :password => '123456') do |client|
+  client.upload! '/tmp/filename1.pdf', :duplex     => true,       :color        => false
+  client.upload! '/tmp/filename2.pdf', :registered => :insertion, :envelope     => :c4
+  client.upload! '/tmp/filename3.pdf', :registered => :standard,  :distribution => :international
+end
+```
+
+### Optionen für Brief
+
+<table width="100%">
+  <tr>
+    <th>Option</th>
+    <th>Werte</th>
+    <th>Vorbelegung</th>
+    <th>Beschreibung</th>
+  </tr>
+  <tr>
+    <td>
+      <strong>:color</strong>
+    </td>
+    <td>
+      <ul>
+        <li>true</li>
+        <li>false</li>
+      </ul>
+    </td>
+    <td>
+      false
+    </td>
+    <td>
+      Farbdruck ja/nein
+    </td>
+  </tr>
+    
+  <tr>
+    <td>
+      <strong>:duplex</strong>
+    </td>
+    <td>
+      <ul>
+        <li>true</li>
+        <li>false</li>
+      </ul>
+    </td>
+    <td>
+      false
+    </td>
+    <td>
+      Duplexdruck ja/nein
+    </td>
+  </tr>
+  
+  <tr>
+    <td>
+      <strong>:envelope</strong>
+    </td>
+    <td>
+      <ul>
+        <li>:din_lang</li>
+        <li>:c4</li>
+      </ul>
+    </td>
+    <td>
+      :din_lang
+    </td>
+    <td>
+      Umschlagformat. DIN lang oder C4.
+    </td>
+  </tr>
+
+  <tr>
+    <td>
+      <strong>:distribution</strong>
+    </td>
+    <td>
+      <ul>
+        <li>:auto</li>
+        <li>:national</li>
+        <li>:international</li>
+      </ul>
+    </td>
+    <td>
+      :auto
+    </td>
+    <td>
+      Versandzone. Automatisch, National, International
+    </td>
+  </tr>
+
+  <tr>
+    <td>
+      <strong>:registered</strong>
+    </td>
+    <td>
+      <ul>
+        <li>:none</li>
+        <li>:insertion</li>
+        <li>:standard</li>
+        <li>:personal</li>
+      </ul>
+    </td>
+    <td>
+      :none
+    </td>
+    <td>
+      Einschreiben: Nein, Einwurf-Einschreiben, Standard-Einschreiben, Einschreiben eigenhändig
+    </td>
+  </tr>
+  
+
+</table>
+
+
+### Hinweis
+
+* PDF-Dateien müssen unter Beachtung der Vorgaben von Onlinebrief24 erstellt und formatiert werden:
+  http://www.onlinebrief24.de/software/infodokumente.htm
+* Dieses gem benutzt die SFTP-Schnittstelle:
+  http://www.onlinebrief24.de/software/sftp-schnittstelle.htm
+
+### Ausprobieren / Keine Funktionsgarantie!
+
+Onlinebrief24 räumt jedem Neukunden ein Guthaben von 5 EUR ein. Es wird empfohlen die Benutzung dieses rubygems damit zu testen. Die vorhandenen Tests (RSpec) im ```spec```-Verzeichnis können dies nicht ersetzen!
+
+
+### Fehler? Probleme? Patches?
+
+Bitte Fehler, Probeme und Patches über Github Issues bzw Pull-Requests einreichen.
 
 ## Contributing
 
@@ -52,6 +185,9 @@ c.disconnect
 4. Push to the branch (`git push origin my-new-feature`)
 5. Create new Pull Request
 
+## Hinweis
+
+Dies ist ein unabhängiges OpenSource-Projekt und kein offizielles Produkt von Onlinebrief24.de.
 
 ## Copyright
 

data/lib/onlinebrief24/client.rb

@@ -4,12 +4,20 @@ module Onlinebrief24
   class Client
     attr_accessor :login, :password, :server, :port, :upload_dir, :fingerprint
 
-    def initialize(opts = {})
+    def initialize(opts = {}, &block)
       @login       = opts[:login]
       @password    = opts[:password]
       @server      = opts[:server]      || 'api.onlinebrief24.de'
       @port        = opts[:port]        || 22
       @upload_dir  = opts[:upload_dir]  || '/upload/api'
+
+      return unless block_given?
+
+      begin
+        yield self
+      ensure
+        disconnect
+      end
     end
 
     def upload!(letter_or_file_handle_or_filename, options = {})
@@ -37,6 +45,7 @@ module Onlinebrief24
     alias_method :connect, :connection
 
     def disconnect
+      puts "disconnecting"
       @connection.close if @connection and @connection.open?
     end
 

data/lib/onlinebrief24/letter.rb

@@ -21,7 +21,7 @@ module Onlinebrief24
 
     def defaults
       {
-        :color        => true,
+        :color        => false,
         :duplex       => false,
         :envelope     => :din_lang,
         :distribution => :auto,

data/lib/onlinebrief24/version.rb

@@ -1,3 +1,3 @@
 module Onlinebrief24
-  VERSION = '1.0.0'
+  VERSION = '1.0.2'
 end

data/onlinebrief24.gemspec

@@ -10,7 +10,7 @@ Gem::Specification.new do |gem|
   gem.email         = ['roland@moriz.de']
   gem.description   = %q{A gem to interact with onlinebrief24.de (send PDFs as physical letters/snail mail)}
   gem.summary       = %q{A gem to interact with onlinebrief24.de (send PDFs as physical letters/snail mail)}
-  gem.homepage      = 'https://github.com/rmoriz'
+  gem.homepage      = 'https://github.com/rmoriz/onlinebrief24'
   gem.license       = 'MIT'
 
   gem.files         = `git ls-files`.split($/)

data/spec/onlinebrief24/client_spec.rb

@@ -55,30 +55,53 @@ describe Onlinebrief24::Client do
 
       it 'should upload the letter with the correct remote filename' do
         sftp = double('sftp')
-        sftp.should_receive(:upload!).with(local_path, '/upload/api/1000000000000_example.pdf').once
+        sftp.should_receive(:upload!).with(local_path, '/upload/api/0000000000000_example.pdf').once
 
         Net::SFTP.should_receive(:start).with('api.onlinebrief24.de', params[:login], :password => params[:password]) { sftp }
 
-        subject.upload!(filehandle).should eql('1000000000000_example.pdf')
+        subject.upload!(filehandle).should eql('0000000000000_example.pdf')
       end
     end
 
     describe 'with a filename' do
       it 'should upload the letter with the correct remote filename' do
         sftp = double('sftp')
-        sftp.should_receive(:upload!).with(local_path, '/upload/api/1000000000000_example.pdf').once
+        sftp.should_receive(:upload!).with(local_path, '/upload/api/0000000000000_example.pdf').once
 
         Net::SFTP.should_receive(:start).with('api.onlinebrief24.de', params[:login], :password => params[:password]) { sftp }
 
-        subject.upload!(local_path).should eql('1000000000000_example.pdf')
+        subject.upload!(local_path).should eql('0000000000000_example.pdf')
       end
       it 'should upload the letter with the correct remote filename with options' do
         sftp = double('sftp')
-        sftp.should_receive(:upload!).with(local_path, '/upload/api/0100000000000_example.pdf').once
+        sftp.should_receive(:upload!).with(local_path, '/upload/api/1100000000000_example.pdf').once
 
         Net::SFTP.should_receive(:start).with('api.onlinebrief24.de', params[:login], :password => params[:password]) { sftp }
 
-        subject.upload!(local_path, :duplex => true, :color => false).should eql('0100000000000_example.pdf')
+        subject.upload!(local_path, :duplex => true, :color => true).should eql('1100000000000_example.pdf')
+      end
+    end
+  end
+
+  describe 'block syntax' do
+    let(:local_path) { File.expand_path('../../example_files/example.pdf', __FILE__) }
+
+    it 'should maintain the connection state' do
+      # re-used connection
+      connection = double('connection')
+      connection.should_receive(:open?).twice { true }
+      connection.should_receive(:upload!).exactly(3).times
+
+      # connect on first demand
+      Net::SFTP.should_receive(:start).once { connection }
+
+      # disconnect when block closes
+      Onlinebrief24::Client.any_instance.should_receive(:disconnect).once
+
+      Onlinebrief24::Client.new(params) do |client|
+        client.upload!(local_path, :color => true)
+        client.upload!(local_path, :color => true)
+        client.upload!(local_path, :color => true)
       end
     end
   end

data/spec/onlinebrief24/letter_spec.rb

@@ -56,7 +56,7 @@ describe Onlinebrief24::Letter do
 
     describe '#color' do
       context 'default' do
-        its(:color) { should be_true }
+        its(:color) { should be_false }
       end
       context 'disabled' do
         let(:options) { { :color => false } }
@@ -124,12 +124,12 @@ describe Onlinebrief24::Letter do
 
     describe 'remote_filename' do
       context 'default' do
-        its(:remote_filename) { should eql('1000000000000_example.pdf') }
+        its(:remote_filename) { should eql('0000000000000_example.pdf') }
       end
 
       context 'default with cost center' do
         let(:options) { { :cost_center => 'trash_and_law' } }
-        its(:remote_filename) { should eql('1000000000000_example#trash_and_law#.pdf') }
+        its(:remote_filename) { should eql('0000000000000_example#trash_and_law#.pdf') }
       end
 
       describe 'color duplex with c4 envelope' do
@@ -140,34 +140,34 @@ describe Onlinebrief24::Letter do
       context 'distribution' do
         describe 'auto' do
           let(:options) { { :distribution => :auto } }
-          its(:remote_filename) { should eql('1000000000000_example.pdf') }
+          its(:remote_filename) { should eql('0000000000000_example.pdf') }
         end
         describe 'national' do
           let(:options) { { :distribution => :national } }
-          its(:remote_filename) { should eql('1001000000000_example.pdf') }
+          its(:remote_filename) { should eql('0001000000000_example.pdf') }
         end
         describe 'international' do
           let(:options) { { :distribution => :international } }
-          its(:remote_filename) { should eql('1003000000000_example.pdf') }
+          its(:remote_filename) { should eql('0003000000000_example.pdf') }
         end
       end
 
       context 'registered (Einschreiben)' do
         describe 'none' do
-          let(:options) { { :registered => :none} }
-          its(:remote_filename) { should eql('1000000000000_example.pdf') }
+          let(:options) { { :registered => :none } }
+          its(:remote_filename) { should eql('0000000000000_example.pdf') }
         end
         describe 'insertion (Einwurf)' do
           let(:options) { { :registered => :insertion } }
-          its(:remote_filename) { should eql('1000100000000_example.pdf') }
+          its(:remote_filename) { should eql('0000100000000_example.pdf') }
         end
         describe 'standard' do
           let(:options) { { :registered => :standard } }
-          its(:remote_filename) { should eql('1000200000000_example.pdf') }
+          its(:remote_filename) { should eql('0000200000000_example.pdf') }
         end
         describe 'personal (eigenhaendig)' do
           let(:options) { { :registered => :personal } }
-          its(:remote_filename) { should eql('1000300000000_example.pdf') }
+          its(:remote_filename) { should eql('0000300000000_example.pdf') }
         end
       end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: onlinebrief24
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.2
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-01-14 00:00:00.000000000 Z
+date: 2013-01-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: net-sftp
@@ -133,7 +133,7 @@ files:
 - spec/onlinebrief24/letter_spec.rb
 - spec/onlinebrief24_spec.rb
 - spec/spec_helper.rb
-homepage: https://github.com/rmoriz
+homepage: https://github.com/rmoriz/onlinebrief24
 licenses:
 - MIT
 post_install_message: 
@@ -148,7 +148,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 2410213596265831708
+      hash: -56571769826084525
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -157,7 +157,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 2410213596265831708
+      hash: -56571769826084525
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.23