onlinebrief24 0.0.1

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,7 @@
+language: ruby
+rvm:
+  - 1.9.3
+  - jruby-19mode
+  - ruby-head
+  - jruby-head
+script: bundle exec rake test

data/Gemfile

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

data/Guardfile

@@ -0,0 +1,11 @@
+# A sample Guardfile
+# More info at https://github.com/guard/guard#readme
+
+guard 'rspec' do
+  watch(%r{^spec/.+_spec\.rb$})
+  watch(%r{^lib/(.+)/(.+)\.rb$}) { |m| "spec/lib/#{m[1]}/#{m[2]}_spec.rb" }
+  watch(%r{^lib/(.+)\.rb$})      { |m| "spec/lib/#{m[1]}_spec.rb" }
+
+  watch('spec/spec_helper.rb')  { "spec" }
+end
+

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Roland Moriz
+
+MIT License
+
+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.md

@@ -0,0 +1,29 @@
+# Onlinebrief24
+
+TODO: Write a gem description
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'onlinebrief24'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install onlinebrief24
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+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

data/Rakefile

@@ -0,0 +1,18 @@
+#encoding: utf-8
+require 'rubygems'
+require 'bundler'
+Bundler.setup
+Bundler::GemHelper.install_tasks
+
+require 'rspec/core/rake_task'
+desc 'Run RSpec'
+RSpec::Core::RakeTask.new do |spec|
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rspec_opts = ['--color', '--format nested']
+end
+
+desc 'Run rspec tests'
+task :test => [:spec]
+
+task :default => :test
+

data/lib/onlinebrief24.rb

@@ -0,0 +1,6 @@
+require 'onlinebrief24/version'
+require 'onlinebrief24/letter'
+require 'onlinebrief24/client'
+
+module Onlinebrief24
+end

data/lib/onlinebrief24/client.rb

@@ -0,0 +1,48 @@
+require 'net/sftp'
+
+module Onlinebrief24
+  class Client
+    attr_accessor :login, :password, :server, :port, :upload_dir, :fingerprint
+
+    def initialize(opts = {})
+      @login       = opts[:login]
+      @password    = opts[:password]
+      @server      = opts[:server]      || 'api.onlinebrief24.de'
+      @port        = opts[:port]        || 22
+      @upload_dir  = opts[:upload_dir]  || '/upload/api'
+    end
+
+    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)
+      elsif letter_or_file_handle_or_filename.is_a?(Onlinebrief24::Letter)
+        letter = letter_or_file_handle_or_filename
+      else
+        raise ArgumentError, letter_or_file_handle_or_filename.class
+      end
+
+      letter.valid?
+
+      connection.upload!(letter.local_path, abs_remote_path(letter.remote_filename))
+
+      letter.remote_filename
+    end
+
+    def connection
+      return @connection if @connection and @connection.open?
+
+      @connection = Net::SFTP.start(@server, @login, :password => @password)
+    end
+    alias_method :connect, :connection
+
+    def disconnect
+      @connection.close if @connection and @connection.open?
+    end
+
+    def abs_remote_path(filename)
+      @upload_dir + '/' + filename
+    end
+
+  end
+end

data/lib/onlinebrief24/letter.rb

@@ -0,0 +1,107 @@
+module Onlinebrief24
+  class InvalidLetterAttributeValueError < StandardError; end
+
+  class Letter
+    attr_accessor :local_path, :local_filename, :color, :duplex, :envelope, :distribution, :registered, :cost_center, :connection
+
+    ENVELOPE_FORMATS     = [ :din_lang, :c4 ]
+    DISTRIBUTION_FORMATS = [ :auto, :national, :international ]
+    REGISTERED_OPTIONS   = [ :none, :insertion, :standard, :personal ]
+
+    def initialize(file_or_filename, options = {})
+      @local_path     = File.expand_path(file_or_filename)
+      @local_filename = File.basename(@local_path)
+
+      defaults.merge(options).each_pair do |setting, value|
+        send("#{setting}=", value)
+      end
+
+      validate_settings
+    end
+
+    def defaults
+      {
+        :color        => true,
+        :duplex       => false,
+        :envelope     => :din_lang,
+        :distribution => :auto,
+        :registered   => :none
+      }
+    end
+
+    def remote_filename
+      rf = '0000000000000' + '_' + with_cost_center(@local_filename)
+
+      case @color
+      when true
+        rf[0] = "1"
+      else
+        rf[0] = "0"
+      end
+
+      case @duplex
+      when true
+        rf[1] = "1"
+      else
+        rf[1] = "0"
+      end
+
+      case @envelope
+      when :c4
+        rf[2] = "1"
+      else
+        rf[2] = "0"
+      end
+
+      case @distribution
+      when :auto
+        rf[3] = "0"
+      when :national
+        rf[3] = "1"
+      when :international
+        rf[3] = "3"
+      end
+
+      case @registered
+      when :none
+        rf[4] = "0"
+      when :insertion
+        rf[4] = "1"
+      when :standard
+        rf[4] = "2"
+      when :personal
+        rf[4] = "3"
+      end
+
+      rf
+    end
+
+    def valid?
+      validate_settings
+    end
+
+    private
+
+    def with_cost_center(filename)
+      if @cost_center
+        filename.gsub(/\.pdf/, "##{@cost_center}#.pdf")
+      else
+        filename
+      end
+    end
+
+    def validate_settings
+      unless ENVELOPE_FORMATS.include? @envelope
+        raise InvalidLetterAttributeValueError, ':envelope value needs to be within: ' + ENVELOPE_FORMATS.join(',') + ' - value was: ' + @envelope.inspect
+      end
+
+      unless DISTRIBUTION_FORMATS.include? @distribution
+        raise InvalidLetterAttributeValueError, ':distribution value needs to be within: ' + DISTRIBUTION_FORMATS.join(',') + '- value was: ' + @distribution.inspect
+      end
+
+      unless REGISTERED_OPTIONS.include? @registered
+        raise InvalidLetterAttributeValueError, ':registered value needs to be within: ' + REGISTERED_OPTIONS.join(',') + '- value was: ' + @registered.inspect
+      end
+    end
+  end
+end

data/lib/onlinebrief24/version.rb

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

data/onlinebrief24.gemspec

@@ -0,0 +1,28 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'onlinebrief24/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = 'onlinebrief24'
+  gem.version       = Onlinebrief24::VERSION
+  gem.authors       = ['Roland Moriz']
+  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.license       = 'MIT'
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ['lib']
+
+  gem.add_dependency 'net-sftp', '~> 2.0'
+
+  gem.add_development_dependency 'rspec', '~> 2.0'
+  gem.add_development_dependency 'rake'
+  gem.add_development_dependency 'guard'
+  gem.add_development_dependency 'guard-rspec'
+  gem.add_development_dependency 'rb-fsevent'
+end

data/spec/onlinebrief24/client_spec.rb

@@ -0,0 +1,78 @@
+require 'spec_helper'
+
+describe Onlinebrief24::Client do
+  let(:params) {
+    {
+      :login    => 'user@example.com',
+      :password => 'fefe_isst_gerne_schweinshaxn',
+    }
+  }
+
+  describe '#initialize' do
+    context 'without parameters' do
+      it 'should instantiate' do
+        described_class.new.should be_instance_of(Onlinebrief24::Client)
+      end
+      its(:server) { should eql('api.onlinebrief24.de') }
+    end
+
+    context 'with parameters' do
+      subject { described_class.new params }
+
+      it { should be_instance_of(Onlinebrief24::Client) }
+      its(:login) { should eql(params[:login]) }
+      its(:password) { should eql(params[:password]) }
+    end
+  end
+
+  describe '#upload' do
+    subject { described_class.new params }
+    let(:local_path) { File.expand_path('../../example_files/example.pdf', __FILE__) }
+    let(:letter) { Onlinebrief24::Letter.new(local_path, letter_options) }
+    let(:letter_options) { {} }
+
+    describe 'without a letter instance' do
+      let(:letter) { nil }
+
+      it { expect{ subject.upload! letter}.to raise_error ArgumentError }
+    end
+
+    describe 'with a valid letter instance' do
+      let(:letter_options) { { :duplex => true, :color => true, :cost_center => 'eris' } }
+
+      it 'should upload the letter with the correct remote filename' do
+        sftp = double('sftp')
+        sftp.should_receive(:upload!).with(local_path, '/upload/api/' + letter.remote_filename).once
+
+        Net::SFTP.should_receive(:start).with('api.onlinebrief24.de', params[:login], :password => params[:password]) { sftp }
+
+        subject.upload!(letter).should eql('1100000000000_example#eris#.pdf')
+      end
+    end
+
+    describe 'with a file handle' do
+      let(:filehandle) { File.open(local_path) }
+
+      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
+
+        Net::SFTP.should_receive(:start).with('api.onlinebrief24.de', params[:login], :password => params[:password]) { sftp }
+
+        subject.upload!(filehandle).should eql('1000000000000_example.pdf')
+      end
+    end
+
+    describe 'with a filenamee' 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
+
+        Net::SFTP.should_receive(:start).with('api.onlinebrief24.de', params[:login], :password => params[:password]) { sftp }
+
+        subject.upload!(local_path).should eql('1000000000000_example.pdf')
+      end
+    end
+  end
+end
+

data/spec/onlinebrief24/letter_spec.rb

@@ -0,0 +1,177 @@
+require 'spec_helper'
+
+describe Onlinebrief24::Letter do
+  subject {
+    Onlinebrief24::Letter.new file_or_filename, options
+  }
+
+  let(:options) { {} }
+  let(:filename) { File.expand_path('../../example_files/example.pdf', __FILE__) }
+
+  describe '#initialize' do
+    context 'without a filename' do
+      subject { Onlinebrief24::Letter.new }
+
+      it 'should raise an error' do
+        expect { subject }.to raise_error ArgumentError
+      end
+    end
+
+    context 'with a filename' do
+      let(:file_or_filename) { filename }
+
+      it { should be_instance_of(Onlinebrief24::Letter) }
+
+      its(:local_path){ should eql(filename) }
+      its(:local_filename){ should eql(File.basename(filename)) }
+    end
+
+    context 'with a file handle' do
+      let(:file_or_filename) { File.open(filename) }
+
+      it { should be_instance_of(Onlinebrief24::Letter) }
+
+      its(:local_path){ should eql(filename) }
+      its(:local_filename){ should eql(File.basename(filename)) }
+    end
+  end
+
+
+  describe 'settings' do
+    let(:file_or_filename) { filename }
+
+    describe '#duplex' do
+      context 'default' do
+        its(:duplex) { should be_false }
+      end
+      context 'disabled' do
+        let(:options) { { :duplex => false } }
+        its(:duplex) { should be_false }
+      end
+      context 'enabled' do
+        let(:options) { { :duplex => true } }
+        its(:duplex) { should be_true }
+      end
+    end
+
+    describe '#color' do
+      context 'default' do
+        its(:color) { should be_true }
+      end
+      context 'disabled' do
+        let(:options) { { :color => false } }
+        its(:color) { should be_false }
+      end
+      context 'enabled' do
+        let(:options) { { :color => true } }
+        its(:color) { should be_true }
+      end
+    end
+
+    describe '#envelope' do
+      context 'default' do
+        its(:envelope) { should eql(:din_lang) }
+      end
+      context 'DIN Lang' do
+        let(:options) { { :envelope => :din_lang } }
+        its(:envelope) { should eql(:din_lang) }
+      end
+      context 'C4' do
+        let(:options) { { :envelope => :c4 } }
+        its(:envelope) { should eql(:c4) }
+      end
+      context 'invalid' do
+        let(:options) { { :envelope => :A0 } }
+        it { expect { subject }.to raise_error(Onlinebrief24::InvalidLetterAttributeValueError) }
+      end
+    end
+
+    describe '#distribution' do
+      context 'default' do
+        its(:distribution) { should eql(:auto) }
+      end
+      context 'national' do
+        let(:options) { { :distribution => :national } }
+        its(:distribution) { should eql(:national) }
+      end
+      context 'invalid' do
+        let(:options) { { :distribution => :warp } }
+        it { expect { subject }.to raise_error(Onlinebrief24::InvalidLetterAttributeValueError) }
+      end
+    end
+
+    describe '#registered' do
+      context 'default' do
+        its(:registered) { should eql(:none) }
+      end
+      context 'insertion' do
+        let(:options) { { :registered => :insertion } }
+        its(:registered) { should eql(:insertion) }
+      end
+      context 'standard' do
+        let(:options) { { :registered => :standard } }
+        its(:registered) { should eql(:standard) }
+      end
+      context 'personal' do
+        let(:options) { { :registered => :personal } }
+        its(:registered) { should eql(:personal) }
+      end
+      context 'invalid' do
+        let(:options) { { :registered => :identmyass } }
+        it { expect { subject }.to raise_error(Onlinebrief24::InvalidLetterAttributeValueError) }
+      end
+    end
+
+    describe 'remote_filename' do
+      context 'default' do
+        its(:remote_filename) { should eql('1000000000000_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') }
+      end
+
+      describe 'color duplex with c4 envelope' do
+        let(:options) { { :color => true, :duplex => true, :envelope => :c4 } }
+        its(:remote_filename) { should eql('1110000000000_example.pdf') }
+      end
+
+      context 'distribution' do
+        describe 'auto' do
+          let(:options) { { :distribution => :auto } }
+          its(:remote_filename) { should eql('1000000000000_example.pdf') }
+        end
+        describe 'national' do
+          let(:options) { { :distribution => :national } }
+          its(:remote_filename) { should eql('1001000000000_example.pdf') }
+        end
+        describe 'international' do
+          let(:options) { { :distribution => :international } }
+          its(:remote_filename) { should eql('1003000000000_example.pdf') }
+        end
+      end
+
+      context 'registered (Einschreiben)' do
+        describe 'none' do
+          let(:options) { { :registered => :none} }
+          its(:remote_filename) { should eql('1000000000000_example.pdf') }
+        end
+        describe 'insertion (Einwurf)' do
+          let(:options) { { :registered => :insertion } }
+          its(:remote_filename) { should eql('1000100000000_example.pdf') }
+        end
+        describe 'standard' do
+          let(:options) { { :registered => :standard } }
+          its(:remote_filename) { should eql('1000200000000_example.pdf') }
+        end
+        describe 'personal (eigenhaendig)' do
+          let(:options) { { :registered => :personal } }
+          its(:remote_filename) { should eql('1000300000000_example.pdf') }
+        end
+      end
+
+    end
+
+  end
+end

data/spec/onlinebrief24_spec.rb

@@ -0,0 +1,7 @@
+require 'spec_helper'
+
+describe Onlinebrief24 do
+  it 'should have a version number' do
+    Onlinebrief24::VERSION.should_not be_nil
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,3 @@
+$LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
+require 'rspec/autorun'
+require 'onlinebrief24'

metadata

@@ -0,0 +1,173 @@
+--- !ruby/object:Gem::Specification
+name: onlinebrief24
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Roland Moriz
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-01-13 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: net-sftp
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: guard
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: guard-rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rb-fsevent
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: A gem to interact with onlinebrief24.de (send PDFs as physical letters/snail
+  mail)
+email:
+- roland@moriz.de
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- .travis.yml
+- Gemfile
+- Guardfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/onlinebrief24.rb
+- lib/onlinebrief24/client.rb
+- lib/onlinebrief24/letter.rb
+- lib/onlinebrief24/version.rb
+- onlinebrief24.gemspec
+- spec/example_files/example.pdf
+- spec/onlinebrief24/client_spec.rb
+- spec/onlinebrief24/letter_spec.rb
+- spec/onlinebrief24_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/rmoriz
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 2273251959082989790
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 2273251959082989790
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: A gem to interact with onlinebrief24.de (send PDFs as physical letters/snail
+  mail)
+test_files:
+- spec/example_files/example.pdf
+- spec/onlinebrief24/client_spec.rb
+- spec/onlinebrief24/letter_spec.rb
+- spec/onlinebrief24_spec.rb
+- spec/spec_helper.rb