infovore-ruminant 0.9.4

data/README

@@ -0,0 +1,70 @@
+Ruminant
+========
+
+Aiming to make the moo API almost as easy to use for developers as the moo.com site itself.
+
+Installation
+------------
+
+If you've never installed a gem from github before - enter the following and you will eternally be graced by a thousand minds:
+gem sources -a http://gems.github.com
+
+Then you can install this like any other gem:
+gem install james-ruminant
+
+
+Usage
+-----
+
+All parameters are done in an ActiveRecord attributes style, i.e. they can be passed into new() as a hash, and are all attr-accessors
+
+Making an order:
+require 'rubygems'
+require 'moo'
+order = Moo::Order.new(:api_key => "your api key")
+
+Adding a product:
+moocard = Moo::MiniCard.new(:url => "http://farm...")
+order.designs << moocard
+
+Adding text
+moocard.text = "This is line 1 \n This is line 2"
+moocard.line(1) #=> This is line 1
+moocard.line(1).bold = true
+moocard.line(1).align = "right"
+moocard.line(1).font = "modern"
+moocard.line(1).colour = "#444444"
+moocard.bold = true # sets bold=true on all lines
+
+Submitting to moo:
+order.to_xml # Gives you the generated xml if you want to manually submit it
+order.submit
+if order.error?
+	order.error_string
+else
+	order.start_url
+end
+
+Current Limitations
+-------------------
+
+Currently I only support MiniCards, but have made it incredibly easy to add the other supported products.
+I haven't yet, as I do not have a personal need, so don't feel I can test it. If you have such a need, do let me know, as we can add it.
+
+Manual Cropping is not currently supported for the same reason.
+
+Please please please do feel to give feedback and/or submit patches. I want this library to be as helpful as possible, but can only do that if I know what you want.
+
+Contributors thus far
+---------------------
+Xenia Kingsley - Naming powers
+Chris Mear - Fixing stuff, and provides the wine
+Dan Webb - Wisdom
+
+
+         (__)
+         (oo)
+  /-------\/
+ / |     ||
+*  ||----||
+   ~~    ~~

data/lib/core_ext/options_struct.rb

@@ -0,0 +1,20 @@
+module OptionsStruct
+  def self.create(*accessors)
+    Class.new do
+      attr_accessor *accessors
+      include Methods
+    end
+  end
+  
+  module Methods
+    def default_options
+      {}
+    end
+  
+    def initialize(options={})
+      default_options.merge(options).each do |name, value|
+        self.send("#{name}=",value)
+      end
+    end
+  end
+end

data/lib/design.rb

@@ -0,0 +1,98 @@
+require 'text_line'
+module Moo
+  class Design < OptionsStruct.create(:url, :type, :crop, :lines, :font_size)
+    def default_options
+      {
+        :lines => [],
+        :crop => 'auto',
+        :type => 'variable'
+      }
+    end
+    
+    def text=(content)
+      content.split("\n").each{|line| lines << TextLine.new(:string => line, :design => self) }
+    end
+    
+    def line(n)
+      lines[n-1]
+    end
+    
+    [:design, :string, :font_size, :bold, :italic, :align, :font, :colour].each do |text_attribute|
+      class_eval %{
+        # Sets #{text_attribute} attribute on all text lines
+        def #{text_attribute}=(value)
+          set_attribute_on_all_lines(:#{text_attribute}, value)
+        end
+      }
+    end
+    
+    def self.disable_attributes(attributes=[])
+      attributes.each do |attribute|
+        class_eval %{
+          def #{attribute}=(*args)
+            raise DisabledAttributeError
+          end
+        }
+      end
+    end
+    
+    def to_xml(xml=Builder::XmlMarkup.new)
+      xml.design {
+        xml.image {
+          xml.url self.url
+          xml.type self.type
+          xml.crop {
+            xml.auto true
+          }
+        }
+        if !product_type.eql?("sticker")
+          xml.text_collection {
+            xml.tag! product_type {
+            xml.minicard {
+              lines.each_with_index do |line, index|
+                xml.text_line {
+                  xml.id index+1
+                  xml.string line.string
+                  xml.bold line.bold
+                  xml.align line.align
+                  xml.font line.font
+                  xml.colour line.colour
+                }
+              end
+            }
+          end
+        }
+      }
+    end
+    
+  private
+    
+    def set_attribute_on_all_lines(attribute, value)
+      @lines.each{|line| line.send("#{attribute}=",value)}
+    end
+    
+  end
+  
+  class MiniCard < Design
+    disable_attributes [:font_size, :italic]
+    
+    def product_type
+      "minicard"
+    end
+  end
+  
+  class Sticker < Design
+    
+    disable_attributes [:font, :font_size, :colour, :align, :bold, :string, :italic]
+    
+    def product_type
+      "sticker"
+    end
+    
+    undef :text=
+    undef :line    
+  end
+  
+  class DisabledAttributeError < StandardError
+  end
+end

data/lib/moo.rb

@@ -0,0 +1,58 @@
+require 'core_ext/options_struct'
+require 'rubygems'
+require 'builder'
+require 'design'
+
+require 'net/http'
+require 'uri'
+require 'hpricot'
+
+module Moo
+  class Order < OptionsStruct.create(:api_key, :designs)
+    def api_version
+      0.7
+    end
+    
+    def default_options
+      {
+        :designs => [],
+        :api_key => 0
+      }
+    end
+    
+    def product_type
+      @designs.first.product_type if @designs.first
+    end
+    
+    def to_xml(xml=nil)
+      xml = Builder::XmlMarkup.new(:target => (@xml_string = "")) unless xml
+      eval File.open(File.expand_path(File.dirname(__FILE__) + "/template.xml.builder")).read
+      xml.target!
+    end
+    
+    attr_accessor :raw_response, :error_string, :error_code, :session_id, :start_url
+    def submit
+      res = Net::HTTP.post_form(URI.parse('http://www.moo.com/api/api.php'),
+                                    {'xml'=>self.to_xml, 'method'=>'direct'})
+      @raw_response = res.body
+      process_response
+      !error?
+    end
+    
+    def process_response
+      @response = Hpricot(raw_response)
+      if error?
+        @error_string = @response.search('error_string').inner_html
+        @error_code = @response.search('error_code').inner_html
+      else
+        @session_id = @response.search('session_id').inner_html
+        @start_url = @response.search('start_url').inner_html
+      end
+    end
+    
+    def error?
+      @error ||= (@response.search('error').inner_html == "true")
+    end
+  end
+  
+end

data/lib/template.xml.builder

@@ -0,0 +1,20 @@
+xml.instruct!
+xml.moo("xsi:noNamespaceSchemaLocation" => "http://www.moo.com/xsd/api_0.7.xsd", "xmlns:xsi" => "http://www.w3.org/2001/XMLSchema-instance") {
+  xml.request {
+    xml.version self.api_version
+    xml.api_key self.api_key
+    xml.call "build"
+  }
+  xml.payload{
+    xml.products {
+      xml.product {
+        xml.product_type self.product_type
+        xml.designs {
+          self.designs.each { |design|
+            design.to_xml(xml)
+          }
+        }
+      }
+    }
+  }
+}

data/lib/text_line.rb

@@ -0,0 +1,12 @@
+module Moo
+  class TextLine < OptionsStruct.create(:design, :string, :font_size, :bold, :italic, :align, :font, :colour)
+    def default_options
+      {
+        :bold => false,
+        :align => 'left',
+        :font => 'modern',
+        :colour => '#000000'
+      }
+    end
+  end
+end

data/spec/design_spec.rb

@@ -0,0 +1,65 @@
+require File.join(File.dirname(__FILE__), *%w[spec_helper])
+
+describe "a minicard" do
+  before :each do
+    @design = Moo::MiniCard.new(:url => "http://farm3.static.flickr.com/2300/2179038972_23d2a1ff40_o.jpg")
+  end
+  
+  it "should have minicard as the type" do
+    @design.product_type.should == "minicard"
+  end
+  
+  it "should not support size" do
+    lambda{@design.font_size = 0.5}.should raise_error(Moo::DisabledAttributeError)
+  end
+  
+  it "should not support italic" do
+    lambda{@design.italic = true}.should raise_error(Moo::DisabledAttributeError)
+  end
+end
+
+describe "a sticker" do
+  before(:each) do
+    @design = Moo::Sticker.new(:url => "")
+  end
+  
+  it "should have sticker as the type" do
+    @design.product_type.should == "sticker"
+  end
+  
+  it "should not support font size" do
+    lambda{@design.font_size = 0.5}.should raise_error(Moo::DisabledAttributeError)
+  end
+  
+  it "should not support italic" do
+    lambda{@design.italic = true}.should raise_error(Moo::DisabledAttributeError)
+  end
+  
+  it "should not support string" do
+    lambda{@design.string = "foo"}.should raise_error(Moo::DisabledAttributeError)
+  end
+  
+  it "should not support bold" do
+    lambda{@design.bold = true}.should raise_error(Moo::DisabledAttributeError)
+  end
+  
+  it "should not support align" do
+    lambda{@design.align = "centre"}.should raise_error(Moo::DisabledAttributeError)
+  end
+  
+  it "should not support font" do
+    lambda{@design.font = "Normal"}.should raise_error(Moo::DisabledAttributeError)
+  end
+  
+  it "should not support colour" do
+    lambda{@design.colour = "#ccc"}.should raise_error(Moo::DisabledAttributeError)
+  end
+  
+  it "should not support any text" do
+    lambda{@design.text = "testing!"}.should raise_error(NoMethodError)
+  end
+  
+  it "should not support lines" do
+    lambda{@design.line(1)}.should raise_error(NoMethodError)
+  end
+end

data/spec/moo_spec.rb

@@ -0,0 +1,85 @@
+require File.join(File.dirname(__FILE__), *%w[spec_helper])
+
+describe "an empty moo order" do
+  before :each do
+    @moo = Moo::Order.new :api_key => "TESTAPIKEY"
+  end
+  
+  it "should have the appropiate header" do
+    @moo.to_xml.should include('<?xml version="1.0" encoding="UTF-8"?><moo xsi:noNamespaceSchemaLocation="http://www.moo.com/xsd/api_0.7.xsd" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">')
+  end
+  
+  it "should user MOO API version 0.7" do
+    @moo.to_xml.should include("<version>0.7</version>")
+  end
+  
+  it "should include the API key" do
+    @moo.to_xml.should include("<api_key>TESTAPIKEY</api_key>")
+  end
+  
+  it "should call build" do
+    @moo.to_xml.should include("<call>build</call>")
+  end
+  
+  it "should not contain to_s" do
+    @moo.to_xml.should_not include("to_s")
+  end
+end
+
+describe "a moo order with a minicard" do
+  before :each do
+    @moo = Moo::Order.new :api_key => "TESTAPIKEY"
+    @minicard = Moo::MiniCard.new(:url => "http://farm3.static.flickr.com/2300/2179038972_23d2a1ff40_o.jpg")
+    @moo.designs << @minicard
+  end
+  
+  it "should have product type of 'minicard'" do
+    @moo.product_type.should == 'minicard'
+    @moo.to_xml.should include('<product_type>minicard</product_type>')
+  end
+  
+  it "should include the xml for the minicard" do
+    @moo.to_xml.should include(@minicard.to_xml)
+  end
+end
+
+describe "processing an XML response for failure" do
+  before :each do
+    @moo = Moo::Order.new :api_key => "TESTAPIKEY"
+    @moo.stub!(:raw_response).and_return('<?xml version="1.0" encoding="UTF-8"?> <moo>  <response>  <call>build</call>  <error>true</error>  </response>  <payload>  <error_code>1</error_code>  <error_string>Error importing XML document</error_string>  </payload> </moo>')
+    @moo.process_response
+  end
+  
+  it "should set error? as true" do
+    @moo.error?.should be_true
+  end
+  
+  it "should set error_string correctly" do
+    @moo.error_string.should == "Error importing XML document"
+  end
+  
+  it "should set error_code correctly" do
+    @moo.error_code.should == "1"
+  end
+end
+
+
+describe "processing an XML response for success" do
+  before :each do
+    @moo = Moo::Order.new :api_key => "TESTAPIKEY"
+    @moo.stub!(:raw_response).and_return('<?xml version="1.0" encoding="UTF-8"?> <moo> <response> <call>build</call> <api_key>3ddbe3c0-17ac-c0a802d2-47bafd19-2473</api_key> </response> <payload> <session_id>d4c7a6d179fca910d67221a57a1bf966</session_id> <start_url>http://www.moo.com/make/designback.php?bid=1&pid=115&SID=d4c7a6d179fca910d67221a57a1bf966</start_url> </payload> </moo>')
+    @moo.process_response
+  end
+  
+  it "should set error? as false" do
+    @moo.error?.should be_false
+  end
+  
+  it "should set start_url correctly" do
+    @moo.start_url.should == "http://www.moo.com/make/designback.php?bid=1&pid=115&SID=d4c7a6d179fca910d67221a57a1bf966"
+  end
+  
+  it "should set session_id correctly" do
+    @moo.session_id.should == "d4c7a6d179fca910d67221a57a1bf966"
+  end
+end

data/spec/product_spec.rb

@@ -0,0 +1,29 @@
+require File.join(File.dirname(__FILE__), *%w[spec_helper])
+
+describe "The Design base class" do
+  before :each do
+    @design = Moo::Design.new(:url => "http://farm3.static.flickr.com/2300/2179038972_23d2a1ff40_o.jpg")
+    @design.stub!(:product_type).and_return("minicard")
+
+    @design.text = "This is Line 1\nAnd this is the second line"
+  end
+  
+  it "should include the design's photo url" do
+    @design.to_xml.should include("<url>http://farm3.static.flickr.com/2300/2179038972_23d2a1ff40_o.jpg</url>")
+  end
+  
+  it "should store the text into multiple TextLines" do
+    @design.line(1).class.should == Moo::TextLine
+    @design.line(1).string.should == "This is Line 1"
+    @design.line(2).class.should == Moo::TextLine
+    @design.line(2).string.should == "And this is the second line"
+  end
+  
+  it "should be able to set an attribute on all lines" do
+    @design.line(1).bold.should == false
+    @design.line(2).bold.should == false
+    @design.bold = true
+    @design.line(1).bold.should == true
+    @design.line(2).bold.should == true
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,6 @@
+$:.unshift File.expand_path(File.dirname(__FILE__) + '/../lib')
+
+require 'rubygems'
+require 'spec'
+
+require 'moo.rb'

metadata

@@ -0,0 +1,78 @@
+--- !ruby/object:Gem::Specification 
+name: infovore-ruminant
+version: !ruby/object:Gem::Version 
+  version: 0.9.4
+platform: ruby
+authors: 
+- James Darling
+- Tom Armitage
+autorequire: 
+bindir: bin
+cert_chain: 
+date: 2008-09-15 00:00:00 -07:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: hpricot
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: builder
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+description: A ruby library to regurgitate MOO products
+email: james@abscond.org tom@infovore.org
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- lib/moo.rb
+- lib/design.rb
+- lib/template.xml.builder
+- lib/text_line.rb
+- lib/core_ext/options_struct.rb
+- README
+has_rdoc: false
+homepage: http://github.com/infovore/ruminant/tree/master
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">"
+    - !ruby/object:Gem::Version 
+      version: 0.0.0
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.2.0
+signing_key: 
+specification_version: 2
+summary: A ruby library to regurgitate MOO products
+test_files: 
+- spec/design_spec.rb
+- spec/moo_spec.rb
+- spec/product_spec.rb
+- spec/spec_helper.rb