onlinebrief24 0.0.1 → 1.0.0

data/README.md

@@ -1,24 +1,48 @@
 # Onlinebrief24
 
-TODO: Write a gem description
+[![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.
+
+## Voraussetzung
+
+Ruby 1.9.2 oder neuer.
 
 ## Installation
 
-Add this line to your application's Gemfile:
+Über Bundler im Gemfile hinzufügen:
+
+```ruby
+gem 'onlinebrief24'
+```
+
+…dann auf der Shell Bundler das Gem installieren lassen:
+
+```shell
+$ bundle
+```
 
-    gem 'onlinebrief24'
+…oder global mit:
 
-And then execute:
+```shell
+$ gem install onlinebrief24
+```
 
-    $ bundle
+## Beispiele
 
-Or install it yourself as:
+#### Kurzform
+```ruby
+require 'onlinebrief24'
 
-    $ gem install onlinebrief24
+c = Onlinebrief24::Client.new :login => 'email@example.com', :password => '123456'
 
-## Usage
+c.upload! '/tmp/filename1.pdf', :duplex     => true,       :color        => false
+c.upload! '/tmp/filename2.pdf', :registered => :insertion, :envelope     => :c4
+c.upload! '/tmp/filename3.pdf', :registered => :standard,  :distribution => :international
+
+c.disconnect
+```
 
-TODO: Write usage instructions here
 
 ## Contributing
 
@@ -27,3 +51,10 @@ TODO: Write usage instructions here
 3. Commit your changes (`git commit -am 'Add some feature'`)
 4. Push to the branch (`git push origin my-new-feature`)
 5. Create new Pull Request
+
+
+## Copyright
+
+Licensed under the MIT license.
+
+Copyright (C) 2013 Moriz GmbH, https://moriz.de/

data/lib/onlinebrief24/client.rb

@@ -15,7 +15,7 @@ module Onlinebrief24
     def upload!(letter_or_file_handle_or_filename, options = {})
 
       if letter_or_file_handle_or_filename.is_a?(File) || letter_or_file_handle_or_filename.is_a?(String)
-        letter = Letter.new(letter_or_file_handle_or_filename)
+        letter = Letter.new(letter_or_file_handle_or_filename, options)
       elsif letter_or_file_handle_or_filename.is_a?(Onlinebrief24::Letter)
         letter = letter_or_file_handle_or_filename
       else

data/lib/onlinebrief24/version.rb

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

data/spec/onlinebrief24/client_spec.rb

@@ -63,7 +63,7 @@ describe Onlinebrief24::Client do
       end
     end
 
-    describe 'with a filenamee' do
+    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
@@ -72,6 +72,14 @@ describe Onlinebrief24::Client do
 
         subject.upload!(local_path).should eql('1000000000000_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
+
+        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')
+      end
     end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: onlinebrief24
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 1.0.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-01-13 00:00:00.000000000 Z
+date: 2013-01-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: net-sftp
@@ -148,7 +148,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 2273251959082989790
+      hash: 2410213596265831708
 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: 2273251959082989790
+      hash: 2410213596265831708
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.23