pixelletter 0.0.1

data/CREDENTIALS.example

@@ -0,0 +1,2 @@
+email: my@email.com
+password: mypassword

data/README.md

@@ -0,0 +1,62 @@
+Pixelletter
+===========
+
+A simple gem to use the API @ pixelletter.de
+
+This gem is not affiliated with http://www.pixelletter.de and not supported by them.
+
+Pixelletter is a small SaaS from Germany. You can use it to send letters. Yay!
+They currently only offer a curl and PHP example usage scenario. I hate PHP and I don't use curl from my Ruby code.
+That's why I created this small gem.
+
+It is a very rough draft. You cannot use the upload they offer.
+That means you have to provide all content via an xml file which the gem creates for you. Just hand the
+content as a hash.
+
+Future versions might provide a more OO approach to creating orders.
+
+# Install
+
+```
+gem install pixelletter
+```
+
+# Requirements
+
+* You need an account at [pixelletter.de](http://www.pixelletter.de)
+* Edit the file `CREDENTIALS.example` and enter your credentials.
+
+# Usage
+
+Initialize a Pixelletter::Request:
+```
+my_request = Pixelletter::Request.new(email: ENV['EMAIL'], password: ENV['PASSWORD'], agb: true, widerrufsrecht: true))
+```
+You can pass an optional attribute: `testmodus: true`. This makes sure no actual orders are created and you are not billed.
+
+
+Create an order hash:
+```
+order: { order:
+          {
+            options: {
+              type: 'text',
+              action: 1,
+              destination: 'DE'
+            },
+            text: {
+              address: "Erika Mustermann\nMusterstr. 2\nD-81237 Musterstadt",
+              subject: 'Das ist der Betreff',
+              message: 'Das ist die Nachricht.'
+            }
+          }
+```
+
+Start a request with this order:
+`my_request.request(order)`
+
+
+# Meta
+Created by Holger Frohloff
+Released under the MIT License: [www.opensource.org/licenses/mit-license.php](www.opensource.org/licenses/mit-license.php)
+

data/Rakefile

@@ -0,0 +1,9 @@
+#!/usr/bin/env rake
+require 'bundler'
+Bundler::GemHelper.install_tasks
+
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec)
+
+task :test => :spec
+task :default => :spec

data/VERSION

@@ -0,0 +1 @@
+0.0.1

data/lib/pixelletter.rb

@@ -0,0 +1,23 @@
+require 'active_support/core_ext'
+require 'attr_required'
+require 'attr_optional'
+require 'restclient_with_cert'
+require 'yaml'
+
+module Pixelletter
+  if File.exists?(File.join(File.dirname('../'), "CREDENTIALS"))
+    f = File.join(File.dirname('../'), "CREDENTIALS")
+    yml = YAML.load(open(f))
+    ENV['EMAIL'] = yml['email']
+    ENV['PASSWORD'] = yml['password']
+  else
+    ENV['EMAIL'] = nil
+    ENV['PASSWORD'] = nil
+  end
+end
+
+require 'pixelletter/base'
+require 'pixelletter/request/request'
+require 'pixelletter/request/xml_builder'
+# require 'pixelletter/order/order'
+# require 'pixelletter/order/text_order'

data/lib/pixelletter/base.rb

@@ -0,0 +1,15 @@
+module Pixelletter
+  class Base
+    include AttrRequired, AttrOptional
+
+    def initialize(attributes = {})
+      if attributes.is_a?(Hash)
+        (required_attributes + optional_attributes).each do |key|
+          value = attributes[key]
+          self.send "#{key}=", value
+        end
+      end
+      attr_missing!
+    end
+  end
+end

data/lib/pixelletter/request/request.rb

@@ -0,0 +1,57 @@
+module Pixelletter
+   class Request < Base
+    attr_required :email, :password, :agb, :widerrufsverzicht, :testmodus
+
+    ENDPOINT = 'https://www.pixelletter.de/xml/index.php'
+
+    def initialize(attributes = {})
+      super
+    end
+
+    def request(order)
+      xml = build_xml(order)
+      xml_file = File.join(File.dirname('../'), "pixml.xml")
+      File.open(xml_file, 'w') { |file| file.write(xml) }
+      upload = File.new(File.join(File.dirname('../'), "pixml.xml"), 'rb')
+
+      response = handle_response do
+        RestClient.post('https://www.pixelletter.de/xml/index.php', xml: upload)
+      end
+
+      File.delete(File.join(File.dirname('../'), "pixml.xml"))
+      return response
+    end
+
+    private
+    def auth
+      {auth:
+        {
+          email: self.email,
+          password: self.password,
+          agb: self.agb,
+          widerrufsverzicht: self.widerrufsverzicht,
+          testmodus: self.testmodus
+        }
+      }
+    end
+
+    def build_xml(order)
+      b = XMLBuilder.new
+      return b.create_xml(auth, order)
+    end
+
+    def handle_response
+      response = yield
+      @doc = Nokogiri::XML(response)
+      value = @doc.xpath('//result').attr("code").value
+      msg = @doc.xpath('//msg').first.child.content if @doc.xpath('//msg').any?
+      id = @doc.xpath('//id').first.child.content if @doc.xpath('//id').any?
+      return {
+        value: value,
+        msg: msg,
+        id: id
+      }
+    end
+
+  end
+end

data/lib/pixelletter/request/xml_builder.rb

@@ -0,0 +1,62 @@
+require 'builder'
+
+module Pixelletter
+  class XMLBuilder < Base
+
+    def initialize
+      super
+    end
+
+
+    #
+    # args = [ {:auth => { email: 'email@email.de', password: 'password', ... }},
+    #          {:options => { ... }}
+    #         ]
+    #
+    #
+    def create_xml(*args)
+      xml = Builder::XmlMarkup.new( :indent => 2 ); false
+      xml.instruct! :xml, :encoding => "UTF-8"
+      xml.tag! "pixelletter", version: '1.0' do
+        args.flatten.each do |element|
+          xml = build_subparts(xml, element)
+        end
+      end
+      finalize_xml(xml)
+    end
+
+    private
+
+    def build_subparts(xml, element)
+      element.each do |key, value|
+        if value.class == Hash
+          xml.tag! key do
+            build_subparts(xml, value)
+          end
+        else
+          # Der Tag <testmodus> erwartet einen Boolean Wert, deshalb kein parsen.
+          if key.to_s == 'testmodus'
+            xml.tag! key, value
+          else
+            xml.tag! key, parse(value)
+          end
+        end
+      end
+      return xml
+    end
+
+    def parse(value)
+      if value == true
+        'ja'
+      elsif value == false
+        'nein'
+      else
+        "#{value}"
+      end
+    end
+
+    def finalize_xml(xml)
+      return xml.target!
+    end
+  end
+end

data/spec/pixelletter_spec.rb

@@ -0,0 +1,32 @@
+require 'spec_helper'
+
+describe Pixelletter do
+  context "with CREDENTIALS FILE" do
+    before do
+      if File.exists?(File.join(File.dirname('../'), "CREDENTIALS"))
+        system("mv #{File.join(File.dirname('../'), "CREDENTIALS")} #{File.join(File.dirname('../'), "CREDENTIALS.bak")}")
+      end
+      f = File.join(File.dirname('../'), "CREDENTIALS")
+      File.open(f, 'w') { |file| file.write("email: test@test.de\npassword: testpass") }
+      f = File.join(File.dirname('../'), "CREDENTIALS")
+      yml = YAML.load(open(f))
+      ENV['EMAIL'] = yml['email']
+      ENV['PASSWORD'] = yml['password']
+    end
+
+    it "should set the correct ENV variables" do
+      ENV['EMAIL'].should eq('test@test.de')
+      ENV['PASSWORD'].should eq('testpass')
+    end
+
+    after do
+      if File.exists?(File.join(File.dirname('../'), "CREDENTIALS.bak"))
+        system("mv #{File.join(File.dirname('../'), "CREDENTIALS.bak")} #{File.join(File.dirname('../'), "CREDENTIALS")}")
+        f = File.join(File.dirname('../'), "CREDENTIALS")
+        yml = YAML.load(open(f))
+        ENV['EMAIL'] = yml['email']
+        ENV['PASSWORD'] = yml['password']
+      end
+    end
+  end
+end

data/spec/request/request_spec.rb

@@ -0,0 +1,99 @@
+# Encoding: UTF-8
+require 'spec_helper'
+
+describe Pixelletter::Request do
+
+  let :attributes do
+    {
+      email:             ENV['EMAIL'],
+      password:          ENV['PASSWORD'],
+      agb:                true,
+      widerrufsverzicht:  true,
+      testmodus:          true
+    }
+  end
+
+  describe '.new' do
+    context 'when any required parameters are missing' do
+      it 'should raise AttrRequired::AttrMissing' do
+        attributes.keys.each do |missing_key|
+          insufficient_attributes = attributes.reject do |key, value|
+            key == missing_key
+          end
+          expect do
+            Pixelletter::Request.new(insufficient_attributes)
+          end.to raise_error AttrRequired::AttrMissing
+        end
+      end
+    end
+
+    context 'when all required parameters are given' do
+      it 'should succeed' do
+        expect do
+          Pixelletter::Request.new(attributes)
+        end.not_to raise_error AttrRequired::AttrMissing
+      end
+    end
+  end
+
+  describe '#request' do
+    context 'with text' do
+      let :order do
+        { order:
+          {
+            options: {
+              type: 'text',
+              action: 1,
+              destination: 'DE'
+            },
+            text: {
+              address: "Erika Mustermann\nMusterstr. 2\nD-81237 Musterstadt",
+              subject: 'Das ist der Betreff',
+              message: 'Das ist die Nachricht.'
+            }
+          }
+        }
+      end
+
+      # <?xml version="1.0" encoding="UTF-8"?>
+      # <pixelletter version="1.1">
+      #   <response>
+      #     <result code="100">
+      #       <msg>Auftrag erfolgreich übermittelt.</msg>
+      #       <id>11954460</id>
+      #     </result>
+      #   </response>
+      # </pixelletter>
+
+      it "should send a successful request" do
+        # order = Pixelletter::TextOrder.new()
+        pr = mock(Pixelletter::Request.new(attributes))
+        pr.stub(:request).with(order).and_return({:value=>"100", :msg=>"Auftrag erfolgreich übermittelt.", :id=>"11954536"})
+        response = pr.request(order)
+        response[:value].should == '100'
+      end
+    end
+
+    context 'with upload' do
+      let :order do
+        { order:
+          {
+            options: {
+              type: 'upload',
+              action: 1,
+              destination: 'DE'
+            }
+          }
+        }
+      end
+
+      it "should send a successful request" do
+        pr = Pixelletter::Request.new(attributes)
+        # pr.stub(:request).with(order).and_return({:value=>"100", :msg=>"Auftrag erfolgreich übermittelt.", :id=>"11954536"})
+        response = pr.request(order)
+        puts response.inspect
+        # response[:value].should == '100'
+      end
+    end
+  end
+end

data/spec/request/xml_builder_spec.rb

@@ -0,0 +1,76 @@
+require 'spec_helper'
+
+describe Pixelletter::XMLBuilder do
+  describe '#create_xml' do
+    let :auth do
+      { auth: { email: 'email@email.de', password: 'password', agb: true, widerrufsverzicht: true, testmodus: true } }
+    end
+
+    it 'should create a valid xml with an <auth> block' do
+      b = Pixelletter::XMLBuilder.new
+      xml = b.create_xml(auth)
+
+      xml.should equal_xml(<<-XML)
+        <?xml version="1.0" encoding="UTF-8"?>
+        <pixelletter version="1.0">
+          <auth>
+            <email>email@email.de</email>
+            <password>password</password>
+            <agb>ja</agb>
+            <widerrufsverzicht>ja</widerrufsverzicht>
+            <testmodus>true</testmodus>
+          </auth>
+        </pixelletter>
+      XML
+    end
+
+    let :order do
+      { order:
+        {
+          options: {
+            type: 'text',
+            action: 1,
+            destination: 'DE'
+          },
+          text: {
+            address: "Erika Mustermann\nMusterstr. 2\nD-81237 Musterstadt",
+            subject: 'Das ist der Betreff',
+            message: 'Das ist die Nachricht.'
+          }
+        }
+      }
+    end
+
+    it 'should create a valid xml with an <auth> and an <order> block' do
+      b = Pixelletter::XMLBuilder.new
+      xml = b.create_xml(auth, order)
+
+      xml.should equal_xml(<<-XML)
+<?xml version="1.0" encoding="UTF-8"?>
+<pixelletter version="1.0">
+  <auth>
+    <email>email@email.de</email>
+    <password>password</password>
+    <agb>ja</agb>
+    <widerrufsverzicht>ja</widerrufsverzicht>
+    <testmodus>true</testmodus>
+  </auth>
+  <order>
+    <options>
+      <type>text</type>
+      <action>1</action>
+      <destination>DE</destination>
+     </options>
+     <text>
+      <address>Erika Mustermann
+Musterstr. 2
+D-81237 Musterstadt</address>
+      <subject>Das ist der Betreff</subject>
+      <message>Das ist die Nachricht.</message>
+     </text>
+  </order>
+</pixelletter>
+      XML
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,10 @@
+require 'simplecov'
+SimpleCov.start
+require 'rspec'
+require 'rspec/autorun'
+require 'test_xml/spec'
+require 'pixelletter'
+
+RSpec.configure do |c|
+  c.mock_with :rspec
+end

metadata

@@ -0,0 +1,249 @@
+--- !ruby/object:Gem::Specification
+name: pixelletter
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Holger Frohloff
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-02-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: attr_required
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: restclient_with_cert
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: builder
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.1.4
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.1.4
+- !ruby/object:Gem::Dependency
+  name: 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: test_xml
+  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: 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: simplecov
+  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.9.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.9.1
+description: A simple gem to use the pixelletter.de API as there exists only an aweful
+  PHP class yet.
+email: holger@5minutenpause.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CREDENTIALS.example
+- Rakefile
+- README.md
+- VERSION
+- lib/pixelletter.rb
+- lib/pixelletter/base.rb
+- lib/pixelletter/request/request.rb
+- lib/pixelletter/request/xml_builder.rb
+- spec/spec_helper.rb
+- spec/pixelletter_spec.rb
+- spec/request/request_spec.rb
+- spec/request/xml_builder_spec.rb
+homepage: http://rubygems.org/gems/pixelletter
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: A gem to use the pixelletter.de API
+test_files: []