psm 0.1.0

data/.gitignore

@@ -0,0 +1,2 @@
+*~
+*.swp

data/README.textile

@@ -0,0 +1,31 @@
+h2. Smail Webservice
+
+p. Print Stuff Mail is snail mail webservice, allowing physical letters to be sent from the comfort of your own command line.
+
+h2. Installation
+
+@gem install psm@
+
+That's it.
+
+h2. Example
+
+<pre>
+  <code>
+    require 'psm'
+    
+    # PrintStuffMail, aliased as PSM, is our namespace.
+    # 1. set your account id.
+    PSM.account_id = 'abcdefg' 
+    
+    # 2. mail a letter!
+    # Since this method will eventually cause a credit card to be charged
+    # we've taken extra precautions to label it as dangerous. The exclamation,
+    # for one, calls attention to the method, but furthermore a block has to be
+    # passed in "confirming" the method.
+    PSM.mail!( 'message', 'address', 'return_address') {|c| c.confirm!}
+    
+    # 3. there is no step three.
+  </code>
+</pre>
+

data/VERSION

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

data/lib/psm.rb

@@ -0,0 +1,61 @@
+require 'net/http'
+require 'psm/session'
+
+# dependencies
+require 'addressable/uri'
+require 'json'
+
+module PrintStuffMail
+
+  BASE_URL = 's.copypastel.com/psm'
+
+  class Confirmation
+    def initialize; @confirmed = false end
+    def confirm!;   @confirmed = true end
+    def confirmed?; @confirmed end
+  end
+
+  class << self
+    attr_accessor :account_id
+    
+    def mail!( message, address, return_address = nil )
+      raise(SecurityError, 'no account_id set.') unless account_id
+      raise(SecurityError, 'need to confirm!') unless block_given?
+      yield c = Confirmation.new
+      raise(SecurityError, 'need to confirm!') unless c.confirmed?
+      
+      @session ||= Session.new account_id
+      raise unless @session.active? or @session.renew! # needs an error type
+      post_letter(message, address, return_address)
+    end
+    
+    private
+    
+    def get_session(account_id)
+      @session = Session.new(account_id)
+    end
+
+    def post_letter(message, address, return_address = nil)
+      uri = Addressable::URI.new  :host => PSM::BASE_URL,
+                                  :path => '/letters/print'
+      params = { :message => message, :address => address, 
+                 :return_address => return_address,
+                 :session => @session.id }
+      params.delete_if {|k, v| v.nil?}
+      uri.query_values = params
+      response = Net::HTTP.start(PrintStuffMail::BASE_URL, 80) do |http|
+        http.post(uri.path, uri.query)
+      end
+      JSON.parse response.body
+    end
+    
+  end
+  
+  def mail!( message, return_address = nil, &block )
+    PSM.mail!( message, self.address, return_address, block)
+  end
+
+end
+
+# Short acronym for quick reference
+PSM = PrintStuffMail

data/lib/psm/session.rb

@@ -0,0 +1,57 @@
+require 'net/http'
+require 'date'
+
+# dependencies
+require 'json'
+
+module PrintStuffMail
+  
+  BASE_URL = 's.copypastel.com/psm'
+  
+  class Session
+    
+    attr_reader :id, :last_response, :expiration
+    
+    def initialize(account_id)      
+      @account_id = account_id
+      raise "(PSM::Session) couldn't get a session token." unless renew! # We don't want to instantiate unless we can get a session
+    end
+    
+    def time_left
+      @expiration - DateTime.now # returns Rational. Wonder which units...
+    end
+    
+    def renew!
+      @last_response = get_response
+      return false unless @last_response['status'] == 201 # We don't have to error out if we can't renew
+      @expiration = DateTime.parse(@last_response['expires'])
+      @id = @last_response['id']
+      true
+    end
+    
+    def expired?
+      (@expiration - DateTime.now) < 0
+    end
+    
+    def active?
+      not expired?
+    end
+    
+    alias_method :valid?, :active?
+    
+    private
+    
+    def get_response
+      query = "account_id=#{@account_id}"
+      begin
+        response = Net::HTTP.start(PrintStuffMail::BASE_URL,80) do |http|
+          http.post("/sessions", query)
+        end
+        JSON.parse(response.body)
+      rescue
+        {}
+      end
+    end
+    
+  end
+end

data/test/fake_service.rb

@@ -0,0 +1,57 @@
+require 'sinatra/base'
+require 'openssl'
+require 'json'
+
+class Letter < Struct.new(:message, :address, :return_address); end
+
+module Helpers
+  
+  @@encrypter = OpenSSL::PKey::RSA.new
+  @@decrypter = OpenSSL::PKey::RSA.new
+  
+  def encrypt(payload)
+    CGI.escape @@encrypter.private_encrypt(params.to_json)
+  end
+  
+  def decrypt(payload)
+    JSON.parse @@encrypter.public_decrypt(CGI.unescape(payload))
+  end
+  
+end
+
+class FakePSM < Sinatra::Base
+  
+  # may be extend
+  include Helpers
+  
+  post '/psm/sessions' do
+    halt 400 unless params[:account_id] == 'john_smith'
+    { :status => 201,
+      :id => 'abcde',
+      :expires => Time.now + 60*30
+      }.to_json
+  end
+  
+  post '/psm/letters/print' do
+    halt 400 unless params[:message] and params[:address] and params[:session] == 'abcde'
+    @letter = Letter.new(params[:message], params[:address], params[:return_address])
+    { :status => 201, 
+      :id => 1,
+      :message => @letter.message,
+      :address => @letter.address,
+      :return_address => @letter.return_address,
+      :state => :processing }.to_json
+  end
+  
+  get '/psm/letters/:id' do
+    halt 400 unless params[:token] == 'abcde'
+    halt 404 if @letter.nil? or params[:id].to_i != 1
+    { :status => 200,
+      :id => 1,
+      :message => @letter.message,
+      :address => @letter.address,
+      :return_address => @letter.return_address,
+      :state => :processing }.to_json
+  end
+  
+end

data/test/psm/session_test.rb

@@ -0,0 +1,43 @@
+require File.expand_path( File.dirname(__FILE__) + '/../test_helper')
+
+require 'psm/session'
+
+class SessionTest < Test::Unit::TestCase
+  
+  include PrintStuffMail
+  
+  context "A Session" do
+    
+    should "raise an exception if it can't get a token when initializing" do
+      assert_raise(RuntimeError) { Session.new 'not_a_valid_account_id' }
+    end
+    
+    setup do
+      Artifice.activate_with(FakePSM)
+      @session = Session.new 'john_smith'
+    end
+    
+    context "after being initialized" do
+      
+      should "measure how long it has left before it needs to renew" do
+        assert @session.time_left > @session.time_left
+      end
+      
+      should "be able to tell if its current token has expired" do
+        assert !@session.expired?
+      end
+      
+      should "have syntaxtic sugar to check if it's token is still valid" do
+        assert @session.valid?
+      end
+      
+      should "be able to renew itself" do
+        old_expiration = @session.expiration
+        sleep 1
+        assert @session.renew!
+        assert @session.expiration > old_expiration
+      end
+      
+    end
+  end
+end

data/test/psm_test.rb

@@ -0,0 +1,105 @@
+require File.expand_path( File.dirname(__FILE__) + '/test_helper')
+
+require 'psm'
+
+class PrintStuffMailTest < Test::Unit::TestCase
+  
+  context "PrintStuffMail" do
+    
+    setup do
+      Artifice.activate_with(FakePSM)
+      @address = "Google\n1600 Amphitheatre Parkway\nMountain View, CA 94043"
+      @return_address = "Apple\n1 Infinite Loop\nCupertino, CA 95014"
+      @message = "Dear Eric,\nStop stealing my designs!\nLove,\nSteve"
+    end
+    
+    should "be referenced by the shorter PSM acronym" do
+      assert_equal PrintStuffMail, PSM
+    end
+    
+    context "as a singleton" do
+      
+      should "define #mail! (it's a dangerous method)" do
+        assert_respond_to PSM, :mail!
+      end
+      
+      should "allow to set an account_id" do
+        assert_respond_to PSM, :account_id
+        assert_respond_to PSM, :account_id=
+      end
+      
+      should "raise a SecurityError unless @account_id isn't set" do
+        assert_raise(SecurityError) { PSM.mail!(@message, @address) {} }
+      end
+
+      context "with a set account_id" do
+        
+        setup do
+          PSM.account_id = 'john_smith'
+        end
+        
+        should "raise a SecurityError unless a 'confirm block' is passed (it's a really dangerous method)" do
+          assert_raise(SecurityError) { PSM.mail!(@message, @address) {} }
+          assert_nothing_raised { PSM.mail!(@message, @address) {|c| c.confirm! } }
+        end
+        
+        should "raise an ArgumentError unless @message and @address are specified" do
+          assert_raise(ArgumentError) { PSM.mail! }
+          assert_raise(ArgumentError) { PSM.mail!(@message) }
+          assert_nothing_raised { PSM.mail!(@message, @address, &:confirm!) }
+        end
+
+        should "accept an optional @return_address" do
+          assert_nothing_raised do
+            PSM.mail!(@message, @address, @return_address, &:confirm!)
+          end
+        end
+
+      end
+      
+    end
+  
+    context "as a module to be #include-d" do
+      
+      setup do
+        class Tempfile; include PSM end
+        @tempfile = Tempfile.new
+      end
+      
+      should "define #mail! in the including class' instances" do
+        assert_respond_to @tempfile, :mail!
+      end
+      
+      should "raise an ArgumentError unless a @message is passed in" do
+        assert_raise(ArgumentError) { @tempfile.mail! }
+        assert_raise(NoMethodError) { @tempfile.mail!(@message) }
+      end
+      
+      should "raise from within #mail! if #address isn't defined" do
+        assert !defined? @tempfile.address
+        assert_raise(NoMethodError) { @tempfile.mail!(@message) }
+      end
+      
+    end
+    
+    context "when accessing the webservice" do
+      
+      should "post letters" do
+        letter = PSM.mail!(@message, @address, @return_address, &:confirm!)
+        assert_equal 'processing', letter['state']
+      end
+      
+      should_eventually "be able to update a letter's status" do
+        
+      end
+      
+    end
+    
+    teardown do
+      Artifice.deactivate
+    end
+    
+  end
+  
+  
+end

data/test/test_helper.rb

@@ -0,0 +1,5 @@
+$LOAD_PATH.unshift File.expand_path( File.dirname(__FILE__) + '/../lib')
+
+require File.expand_path( File.dirname(__FILE__) + '/fake_service')
+require 'shoulda'
+require 'artifice'

metadata

@@ -0,0 +1,128 @@
+--- !ruby/object:Gem::Specification 
+name: psm
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- ecin
+- daicoden
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-04-26 00:00:00 -04:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: addressable
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 2
+        - 1
+        - 1
+        version: 2.1.1
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: json
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 1
+        - 2
+        - 3
+        version: 1.2.3
+  type: :runtime
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: shoulda
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 2
+        - 10
+        - 3
+        version: 2.10.3
+  type: :development
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: artifice
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        - 5
+        version: "0.5"
+  type: :development
+  version_requirements: *id004
+description: Print Stuff Mail provides an RESTful API for sending snail mail. This library eases interfacing with it.
+email: "@copypastel.com"
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.textile
+files: 
+- .gitignore
+- README.textile
+- VERSION
+- lib/psm.rb
+- lib/psm/session.rb
+- test/fake_service.rb
+- test/psm/session_test.rb
+- test/psm_test.rb
+- test/test_helper.rb
+has_rdoc: true
+homepage: http://github.com/copypastel/print_stuff_mail
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.6
+signing_key: 
+specification_version: 3
+summary: Client library for Print Stuff Mail, the snail mail webservice.
+test_files: 
+- test/fake_service.rb
+- test/psm/session_test.rb
+- test/psm_test.rb
+- test/test_helper.rb