mandao 0.0.1 → 0.0.2pre

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 58644bbb6aba2476b05b6d702a384f2fc9c1b06e
-  data.tar.gz: 76c812d8c68f7a8d8dcced5436c6b89ebb9ff03b
+  metadata.gz: 4be4b5ae37269795d42e7b34ba1f9e1ddab0f0a1
+  data.tar.gz: 5cd84033120c48876de7f6f0ce53aa6be32ef31c
 SHA512:
-  metadata.gz: 917a65ae5842d0d3f262a70cf7a15d1eb9fdc879199c3989abab22b9f31575ce8244b767cebe1a471323a68d0e98a04b334fae9d5042822664dd445d475a3c19
-  data.tar.gz: b399a72a298c4855dfe79370e61e6df3781aa01ef5233297ac3ac1fdcebb9f66806fc5e019a438573433f2aa93c1eb66f626bc554bbb0972292785ba6eb89146
+  metadata.gz: fe717b0cb9ea9249bef8d4dabd5dc4993cc00a1d14094e570af80ea49868fd6600f4f6cbca389fd6e7b579a3c31b371fabdbf86ab5ed067e0c23f6c98aeb2471
+  data.tar.gz: 2f154fe98a9e903fba86e928e10793b0f032fc22d5f53e078e3dd67bd5bff5d630ef8f28baff23141fbc9c0191f3a9e27737f0921426ee201e39ca69f0dc3d62

data/.gitignore

@@ -22,6 +22,7 @@ mkmf.log
 /test/tmp/
 /test/version_tmp/
 /tmp/
+/push/
 
 ## Specific to RubyMotion:
 .dat*
@@ -38,6 +39,7 @@ build/
 /.bundle/
 /lib/bundler/man/
 
+
 # for a library or gem, you might want to ignore these files since the code is
 # intended to run in multiple environments; otherwise, check them in:
 # Gemfile.lock

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--require spec_helper

data/lib/mandao/configuration.rb

@@ -0,0 +1,49 @@
+
+module Mandao
+
+  class << self
+    attr_accessor :configuration
+  end
+
+  def self.configure
+    self.configuration ||= Configuration.new
+    yield(configuration)
+    Mandao::Base.activate
+  end
+
+  def self.config
+    self.configuration
+  end
+
+  class Configuration
+    attr_accessor :endpoint
+    attr_accessor :username
+    attr_accessor :password
+    attr_accessor :protocol
+    attr_accessor :format
+
+    VALID_OPTIONS_KEYS = [:endpoint, :username, :password]
+    REQUIRED_OPTIONS   = [:username, :password]
+    DEFAULT_PROTOCOL   = "https".freeze
+    DEFAULT_ENDPOINT   = 'stage.rest.click2mail.com/v1'.freeze # TODO [ add production endpoint by default ]
+    DEFAULT_FORMAT     = ActiveResource::Formats::XmlFormat
+
+    def initialize
+      @endpoint = DEFAULT_ENDPOINT
+      @protocol = DEFAULT_PROTOCOL
+      @format   = DEFAULT_FORMAT
+    end
+
+    def api_endpoint
+      "#{@protocol}://#{@username}:#{@password}@#{@endpoint}/"
+    end
+
+    def valid?
+      REQUIRED_OPTIONS.each do |opt|
+        raise StandardError, 'You must provide username and password.' if send(opt)
+      end
+    end
+
+  end
+
+end

data/lib/mandao/resources/address.rb

@@ -0,0 +1,35 @@
+module Mandao
+  class Address
+    attr_accessor :first_name, :last_name, :organization, :address1, 
+    :address2, :address3, :city, :state, :zip, :country_non_us
+    
+    def initialize(options={})
+      @first_name = options[:first_name]
+      @last_name = options[:last_name]
+      @organization = options[:organization]
+      @address1 = options[:address1]
+      @address2 = options[:address2]
+      @address3 = options[:address3]
+      @city = options[:city]
+      @state = options[:state]
+      @zip = options[:zip]
+      @country_non_us = options[:country_non_us]
+    end
+
+    def to_xml
+      "<address>
+        <First_name>#{ @first_name }</First_name>
+        <Last_Name>#{ @last_name }</Last_Name>
+        <Organization>#{ @organization }</Organization>
+        <Address1>#{ @address1 }</Address1>
+        <Address2>#{ @address2 }</Address2>
+        <Address3>#{ @address3 }</Address3>
+        <City>#{@city}</City>
+        <State>#{@state}</State>
+        <Zip>#{@zip}</Zip>
+        <Country_non-US>#{@country_non_us}</Country_non-US>
+      </address>"
+    end
+
+  end
+end

data/lib/mandao/resources/address_list.rb

@@ -0,0 +1,49 @@
+module Mandao
+
+  class AddressListCollection < ActiveResource::Collection
+    def initialize(parsed = {})
+      attrs = []
+      attrs << parsed['addressList'] if parsed['addressList'].is_a? Hash
+      @elements = attrs || parsed['addressList']
+    end
+  end
+
+  class AddressList < Base
+    self.collection_name = "addressLists"
+    self.collection_parser = Mandao::AddressListCollection
+
+    class << self
+
+      def create(list_name, addresses=[])
+        if list_name && addresses
+          xml = generate_xml(addresses)
+          begin
+            response = RestClient.post("#{self.site}#{ self.collection_name }", xml, content_type: :xml )
+            attrs = parse_response(response)
+            Mandao::AddressList.new(attrs)
+          rescue
+          end
+        else
+          raise StandardError, 'Address List must contain a name and at least one address.'
+        end
+      end
+
+      def generate_xml(addresses)
+        addresses_xml = ""
+        addresses.each do |address_attrs|
+          addresses_xml += Mandao::Address.new(address_attrs).to_xml
+        end
+        "<addressList>
+          <addressListName>Best Customers test</addressListName>
+          <addressMappingId>2</addressMappingId>
+          <addresses>
+            #{ addresses_xml }
+          </addresses>
+        </addressList>"
+      end
+
+    end
+
+  end
+
+end

data/lib/mandao/resources/base.rb

@@ -0,0 +1,19 @@
+module Mandao
+  class Base < ActiveResource::Base
+    self.include_format_in_path = false
+
+    class << self
+
+      def activate
+        self.site = Mandao.config.api_endpoint
+        self.format = Mandao.config.format
+      end
+
+      def parse_response(xml)
+        ActiveResource::Formats::XmlFormat.decode(xml)
+      end
+
+    end
+
+  end
+end

data/lib/mandao/resources/document.rb

@@ -0,0 +1,24 @@
+module Mandao
+
+  class DocumentCollection < ActiveResource::Collection
+    def initialize(parsed = {})
+      attrs = []
+      attrs << parsed['document'] if parsed['document'].is_a? Hash
+      @elements = attrs || parsed['document']
+    end
+  end
+
+  class Document < Base
+    self.collection_parser = Mandao::DocumentCollection
+
+    class << self
+      def create(file, content_type='application/pdf')
+        response = RestClient.post("#{self.site}documents", file, content_type: content_type, accept: 'application/xml')
+        attrs = parse_response(response)
+        Mandao::Document.new(attrs)
+      end
+    end
+
+  end
+
+end

data/lib/mandao/version.rb

@@ -1,3 +1,3 @@
 module Mandao
-  VERSION = "0.0.1"
+  VERSION = "0.0.2pre"
 end

data/lib/mandao/xml_format.rb

@@ -0,0 +1,16 @@
+module ActiveResource
+  module Formats
+    module XmlFormat
+
+      def decode(xml)
+        data = Hash.from_xml(xml)
+        if data.is_a?(Hash) && data.keys.size == 1
+          data.values.first
+        else
+          data
+        end
+      end
+
+    end
+  end
+end

data/lib/mandao.rb

@@ -1,5 +1,2 @@
-require "mandao/version"
-
-module Mandao
-  # Your code goes here...
-end
+require 'mandao/version'
+require 'mandao/configuration'

data/mandao.gemspec

@@ -9,7 +9,7 @@ Gem::Specification.new do |spec|
   spec.authors       = ["Marlon Mantilla"]
   spec.email         = ["me@marlonmantilla.com"]
   spec.summary       = %q{Mandao is a cool gem for accessing the Click2Mail REST API. https://developers.click2mail.com/rest-api/molpro/getting-started/main}
-  spec.description   = %q{Mandao gem allows developers to access Click2Mail REST services in a simple way.}
+  spec.description   = %q{Mandao allows you to access Click2Mail REST services in a simple way.}
   spec.homepage      = ""
   spec.license       = "MIT"
 
@@ -18,7 +18,12 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ["lib"]
 
+  spec.add_runtime_dependency "activeresource", "~> 4.0"
+  spec.add_runtime_dependency "rest-client", "~> 1.7"
+
   spec.add_development_dependency "bundler", "~> 1.7"
   spec.add_development_dependency "rake", "~> 10.0"
-  spec.add_development_dependency "rspec", "~> 3.1.0"
+  spec.add_development_dependency "rspec", "~> 3.1"
+  spec.add_development_dependency "webmock", "~> 1.19"
+
 end

data/spec/mandao/address_list_spec.rb

@@ -0,0 +1,37 @@
+require File.expand_path('../../spec_helper', __FILE__)
+
+describe Mandao::AddressList do
+
+  before do
+    Mandao.configure do |config|
+      config.endpoint = Mandao::Configuration::DEFAULT_ENDPOINT
+      config.username = "username"
+      config.password = "password"
+    end
+    stub_address_lists
+    stub_address_lists_post
+  end
+
+  it 'should return all address lists' do
+    address_lists = Mandao::AddressList.all
+    expect(address_lists).to be_present
+  end
+
+  it 'should create an address list' do
+    address_lists = [{ 
+      first_name: 'John',
+      last_name: 'Doe',
+      organization: 'Umbrella',
+      address1: '742 Evergreen Terrace',
+      address2: '743 Evergreen Terrace',
+      address3: '',
+      city: 'Springfield',
+      state: 'MA',
+      zip: '12345',
+      country_non_us: ''
+    }]
+    address_list = Mandao::AddressList.create("My Address List", address_lists)
+    expect(address_list).to be_present
+  end
+
+end

data/spec/mandao/document_spec.rb

@@ -0,0 +1,26 @@
+require File.expand_path('../../spec_helper', __FILE__)
+
+describe Mandao::Document do
+
+  before do
+    Mandao.configure do |config|
+      config.endpoint = Mandao::Configuration::DEFAULT_ENDPOINT
+      config.username = "username"
+      config.password = "password"
+    end
+    stub_documents
+    stub_document_post
+  end
+
+  it 'should return all documents' do
+    documents = Mandao::Document.all
+    expect(documents).to be_present
+  end
+
+  it 'should create a document with a pdf' do
+    pdf = File.open(File.expand_path('../files/document.pdf', __FILE__), 'rb')
+    document = Mandao::Document.create(pdf)
+    expect(document).to be_present
+  end
+
+end