midwife-client 0.0.2

data/.gitignore

@@ -0,0 +1,4 @@
+pkg/*
+*.gem
+.bundle
+Gemfile.lock

data/Gemfile

@@ -0,0 +1,4 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in midwife-client.gemspec
+gemspec

data/README.md

@@ -0,0 +1,28 @@
+# Midwife Client
+
+A wrapper for the Midwife API
+
+## Usage
+
+    client = Midwife::Client.new('API_KEY')
+
+    list = client.create_list(:name => 'April 2011 eVetTen')
+
+    client.create_recipient(:list_id    => list['id'],
+                         :first_name => 'Michael',
+                         :last_name  => 'Jordan',
+                         :email      => 'michael@jordan.com')
+
+    campaign = client.create_campaign(:name       => 'April 2011 eVetTen',
+                                      :from_name  => 'Robert Eversole',
+                                      :from_email => 'robert.eversole@recruitmilitary.com',
+                                      :subject    => '[RecruitMilitary] April eVetTen',
+                                      :html_body  => html_body,
+                                      :plain_body => plain_body)
+
+    client.deliver_campaign(:campaign_id => campaign['id'])
+
+## TODO
+
+* Better specs (currently connects to a local instance of midwife)
+* Error handling

data/Rakefile

@@ -0,0 +1,8 @@
+require 'bundler'
+Bundler::GemHelper.install_tasks
+
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new
+
+task :default => :spec

data/lib/midwife-client.rb

@@ -0,0 +1 @@
+require 'midwife/client'

data/lib/midwife/client.rb

@@ -0,0 +1,66 @@
+require "net/http"
+require "uri"
+require "json"
+
+module Midwife
+  class RequestError < StandardError
+    attr_reader :response
+
+    def initialize(response)
+      @response = response
+    end
+  end
+
+  module Request
+    private
+
+    def request(path, attributes)
+      uri = URI.parse(@endpoint + path)
+      response = Net::HTTP.post_form(uri, attributes)
+
+      if response.code =~ /2../
+        JSON.parse(response.body)
+      else
+        raise RequestError.new(response)
+      end
+    end
+  end
+
+  class Client
+
+    include Request
+
+    def initialize(endpoint = 'http://localhost:3000')
+      @endpoint = endpoint
+    end
+
+    def create_list(attributes)
+      request "/lists", attributes
+    end
+
+    def create_recipient(attributes)
+      list_id = attributes.delete(:list_id) {
+        raise ArgumentError, "list_id is required"
+      }
+
+      request "/lists/#{list_id}/recipients", attributes
+    end
+
+    def create_campaign(attributes)
+      request "/campaigns", attributes
+    end
+
+    def deliver_campaign(attributes)
+      campaign_id = attributes.delete(:campaign_id) {
+        raise ArgumentError, "campaign_id is required"
+      }
+
+      unless attributes.has_key?(:list_id)
+        raise ArgumentError, "list_id is required"
+      end
+
+      request "/campaigns/#{campaign_id}/deliver", attributes
+    end
+
+  end
+end

data/lib/midwife/client/version.rb

@@ -0,0 +1,5 @@
+module Midwife
+  class Client
+    VERSION = "0.0.2"
+  end
+end

data/midwife-client.gemspec

@@ -0,0 +1,25 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "midwife/client/version"
+
+Gem::Specification.new do |s|
+  s.name        = "midwife-client"
+  s.version     = Midwife::Client::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Michael Guterl"]
+  s.email       = ["mguterl@gmail.com"]
+  s.homepage    = ""
+  s.summary     = %q{A ruby wrapper for the Midwife HTTP API}
+  s.description = %q{A ruby wrapper for the Midwife HTTP API}
+
+  s.rubyforge_project = "midwife-client"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  s.add_dependency 'json'
+
+  s.add_development_dependency 'rspec', '~> 2.5'
+end

data/spec/client_spec.rb

@@ -0,0 +1,141 @@
+require 'spec_helper'
+
+module TestRequest
+
+  class Request < Struct.new(:path, :params, :method); end
+
+  def request(path, attributes)
+    requests << Request.new(path, attributes, :post)
+  end
+
+  def requests
+    @requests ||= []
+  end
+
+  def reset
+    @requests = nil
+  end
+
+end
+
+describe Midwife::Client do
+
+  it 'is able to be created' do
+    Midwife::Client.new
+  end
+
+  context 'requests' do
+    let(:client) {
+      client = Midwife::Client.new
+      client.extend TestRequest
+      client
+    }
+
+    before do
+      client.reset
+      @campaign_attributes = {
+        'name'       => 'April 2011 eVetTen',
+        'from_name'  => 'Robert Eversole',
+        'from_email' => 'robert.eversole@recruitmilitary.com',
+        'subject'    => '[RecruitMilitary] April eVetTen',
+        'html_body'  => '<p>Hello world</p>',
+        'plain_body' => 'hello world'
+      }
+    end
+
+    def last_request
+      client.requests.last
+    end
+
+    describe '#create_list' do
+      it 'creates a list' do
+        client.create_list(:name => 'April 2011 eVetTen')
+
+        last_request.path.should == '/lists'
+        last_request.method.should == :post
+        last_request.params.should == { :name => 'April 2011 eVetTen' }
+      end
+    end
+
+    describe '#create_recipient' do
+      it 'adds a recipient to the list' do
+        client.create_recipient(:list_id => 42, :email => 'michael@jordan.com')
+
+        last_request.path.should == "/lists/42/recipients"
+        last_request.method.should == :post
+        last_request.params.should == { :email => 'michael@jordan.com' }
+      end
+
+      context 'when list_id is missing' do
+        it 'raises an error' do
+          expect {
+            client.create_recipient(:email => 'michael@jordan.com')
+          }.to raise_error
+        end
+      end
+    end
+
+    describe '#create_campaign' do
+      it 'creates a campaign' do
+        client.create_campaign(@campaign_attributes)
+
+        last_request.path.should == "/campaigns"
+        last_request.method.should == :post
+        last_request.params.should == @campaign_attributes
+      end
+    end
+
+    describe '#deliver_campaign' do
+      it 'delivers a campaign to the specified list' do
+        client.deliver_campaign(:campaign_id => 2, :list_id => 3)
+
+        last_request.path.should == "/campaigns/2/deliver"
+        last_request.method.should == :post
+        last_request.params.should == { :list_id => 3 }
+      end
+
+      context 'when campaign id is missing' do
+        it 'raises an error' do
+          expect {
+            client.deliver_campaign(:list_id => 42)
+          }.to raise_error
+        end
+      end
+
+      context 'when list id is missing' do
+        it 'raises an error' do
+          expect {
+            client.deliver_campaign(:campaign_id => 42)
+          }.to raise_error
+        end
+      end
+    end
+  end
+
+  context 'when processing a non-success response' do
+    let(:client) { Midwife::Client.new }
+    let(:response) { double(:code => '404') }
+
+
+    before do
+      Net::HTTP.stub(:post_form).and_return(response)
+    end
+
+    it 'raises an exception' do
+      expect {
+        client.create_list(:name => 'illegal name')
+      }.to raise_error(Midwife::RequestError)
+    end
+
+    context 'the exception' do
+      it 'contains the entire response' do
+        begin
+          client.create_list(:name => 'illegal name')
+        rescue => e
+          e.response.should == response
+        end
+      end
+    end
+  end
+
+end

data/spec_helper.rb

@@ -0,0 +1,9 @@
+$LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
+$LOAD_PATH.unshift File.dirname(__FILE__)
+
+require 'rspec'
+require 'midwife/client'
+
+# Requires supporting files with custom matchers and macros, etc,
+# in ./support/ and its subdirectories.
+Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each {|f| require f}

metadata

@@ -0,0 +1,105 @@
+--- !ruby/object:Gem::Specification 
+name: midwife-client
+version: !ruby/object:Gem::Version 
+  hash: 27
+  prerelease: false
+  segments: 
+  - 0
+  - 0
+  - 2
+  version: 0.0.2
+platform: ruby
+authors: 
+- Michael Guterl
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-05-04 00:00:00 -04:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: json
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 9
+        segments: 
+        - 2
+        - 5
+        version: "2.5"
+  type: :development
+  version_requirements: *id002
+description: A ruby wrapper for the Midwife HTTP API
+email: 
+- mguterl@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- Gemfile
+- README.md
+- Rakefile
+- lib/midwife-client.rb
+- lib/midwife/client.rb
+- lib/midwife/client/version.rb
+- midwife-client.gemspec
+- spec/client_spec.rb
+- spec_helper.rb
+has_rdoc: true
+homepage: ""
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: midwife-client
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: A ruby wrapper for the Midwife HTTP API
+test_files: 
+- spec/client_spec.rb