lady_gaga 0.0.1

data/.gitignore

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

data/.rvmrc

@@ -0,0 +1 @@
+rvm ree@lady_gaga

data/Gemfile

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

data/README.md

@@ -0,0 +1,67 @@
+Lady Gaga
+======
+
+Lady Gaga is a minimalistic, Nokogiri-based Ruby wrapper to the [Endicia Web Services API](http://www.endicia.com/Developers/).
+
+Currently the following APIs are supported:
+  - [Dial-A-ZIP Address Verification API](http://www.endicia.com/Developers/ZipLookup/)
+
+Usage
+-----
+Set up.
+
+    LadyGaga.configure do |config|
+      config.user = '1234'
+      config.password = 'password'
+    end
+
+Initialize a request
+
+    request = LadyGaga::DialAZip.new
+
+Build request params.
+
+    request << {
+      'ADDRESS0' => 'John Doe',
+      'ADDRESS1' => 'DYMO Endicia',
+      'ADDRESS2' => '385 Sherman Ave',
+      'ADDRESS3' => 'Palo Alto, CA 94306'
+    }
+
+Get a response.
+
+    response = request.post
+
+Check response validity:
+
+    response.code
+    returns: "200"
+
+    response.valid?
+    returns: true
+
+Convert response to hash:
+
+    response.to_h
+
+    returns: {
+    'Dial-A-ZIP_Response' => {
+        'AddrLine1'    => '385 Sherman Ave',
+        'AddrLine2'    => 'DYMO ENDICIA',
+        'AddrLine3'    => '',
+        'AddrLineLast' => 'PALO ALTO CA 94306-1864'
+      }
+     }
+
+
+Or parse a response with Nokogiri:
+
+    response.xml.css("Dial-A-ZIP_Response").each do |r|
+      some business value
+    end
+
+    response.xml.xpath("//User")
+
+----
+
+To get started with the Dial-A-Zip Address Verification API, Sign Up for an Endicia Account and request API access.

data/Rakefile

@@ -0,0 +1,17 @@
+require 'bundler'
+require 'cucumber/rake/task'
+require 'rspec/core/rake_task'
+
+Bundler::GemHelper.install_tasks
+
+desc 'Run all specs in spec directory'
+RSpec::Core::RakeTask.new(:spec) do |t|
+  t.pattern = "spec/**/*_spec.rb"
+  t.rspec_opts = %w(-fd -c)
+end
+
+Cucumber::Rake::Task.new(:features) do |t|
+  t.cucumber_opts = "features --format pretty"
+end
+
+task :default => [:spec, :features]

data/features/dial_a_zip.feature

@@ -0,0 +1,15 @@
+Feature: Endicia Dial-A-ZIP
+  As an API consumer
+
+  Background:
+    Given a new DialAZip request
+
+  Scenario: 
+    Given the following parameters:
+        | ADDRESS0 | ADDRESS1     | ADDRESS2        | ADDRESS3            |
+        | John Doe | DYMO Endicia | 385 Sherman Ave | Palo Alto, CA 94306 |
+     When I tape the "dial_a_zip" request as: "address_verification"
+     Then the response code should be "200"
+     And the returned address should equal:
+        | AddrLine1       | AddrLine2    | AddrLineLast            |
+        | 385 SHERMAN AVE | DYMO ENDICIA | PALO ALTO CA 94306-1864 |

data/features/step_definitions/dial_a_zip_steps.rb

@@ -0,0 +1,15 @@
+Given /^a new DialAZip request$/ do
+  @request = LadyGaga::DialAZip.new
+end
+
+Then /^the returned address should equal:$/ do |table|
+  response = @response.to_h['Dial_A_ZIP_Response']
+
+  table.hashes.each do |address|
+    address.each_pair do |k,v|
+      returned_value = response[k]
+      returned_value.should == v
+    end
+  end
+end
+

data/features/step_definitions/lady_gaga_steps.rb

@@ -0,0 +1,19 @@
+Given /^the following parameters:$/ do |table|
+  table.hashes.each do |h|
+    @request << h
+  end
+end
+
+When /^I tape the "([^"]*)" request as: "([^"]*)"$/ do |service, operation|
+  VCR.use_cassette("#{service}/#{operation}/#{cassette_name}", :record => :new_episodes) do
+    @response = @request.post
+  end
+end
+
+Then /^the response code should be "([^"]*)"$/ do |code|
+  @response.code.should == code.to_i
+end
+
+Then /^the response should have (\d+) "([^"]*)" nodes$/ do |count, node|
+  @response.xml.css(node).count.should == count.to_i
+end

data/features/support/env.rb

@@ -0,0 +1,32 @@
+require 'rubygems'
+require 'bundler/setup'
+require 'digest/md5'
+require 'lady_gaga'
+
+
+module LadyGagaMethods
+  def cassette_name
+    Digest::MD5.hexdigest(@request.options.to_json)
+  end
+
+  def endicia
+    @endicia ||= YAML::load_file(File.dirname(__FILE__) + "/../../spec/support/endicia.yml")
+  end
+
+  def endicia_user
+    endicia['user']
+  end
+
+  def endicia_password
+    endicia['password']
+  end
+end
+
+World(LadyGagaMethods)
+
+Before do
+  LadyGaga.configure do |config|
+    config.user = endicia_user
+    config.password = endicia_password
+  end
+end

data/features/support/vcr.rb

@@ -0,0 +1,9 @@
+require 'vcr'
+
+VCR.config do |c|
+  c.cassette_library_dir     = File.dirname(__FILE__) + '/../../spec/fixtures/cassettes'
+  c.default_cassette_options = {
+    :record             => :none,
+    :match_requests_on  => [:host] }
+  c.stub_with :webmock
+end

data/lady_gaga.gemspec

@@ -0,0 +1,38 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "lady_gaga/version"
+
+Gem::Specification.new do |s|
+  s.name        = "lady_gaga"
+  s.version     = LadyGaga::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Ryan Closner"]
+  s.email       = ["ryan.closner@gmail.com"]
+  s.homepage    = "https://rubygems.org/gems/lady_gaga"
+  s.summary     = %q{A Ruby Wrapper to the Endicia API}
+  s.description = %q{A minimalistic Ruby Wrapper to the Endicia API}
+
+  s.rubyforge_project = "lady_gaga"
+
+  {
+    'httparty'            => '~> 0.7.7',
+    'nokogiri'            => '~> 1.4.4',
+    'activesupport'      => '~> 2.3.10'
+  }.each {|lib, version| s.add_runtime_dependency lib, version }
+
+  {
+    'bundler'             => '~> 1.0.0',
+    'addressable'         => '2.2.4',
+    'cucumber'            => '~> 0.10.0',
+    'rake'                => '~> 0.8.7',
+    'relish'              => '~> 0.3.0.pre',
+    'rspec'               => '~> 2.5.0',
+    'vcr'                 => '~> 1.9.0',
+    'webmock'             => '~> 1.6.0'
+  }.each {|lib, version| s.add_development_dependency lib, version }
+
+  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"]
+end

data/lib/lady_gaga.rb

@@ -0,0 +1,12 @@
+require 'lady_gaga/request'
+require 'lady_gaga/response'
+require 'lady_gaga/config'
+require 'lady_gaga/dial_a_zip'
+
+module LadyGaga
+  class << self
+    def configure(&block)
+      yield Config
+    end
+  end
+end

data/lib/lady_gaga/config.rb

@@ -0,0 +1,23 @@
+module LadyGaga
+  class Config
+
+    class << self
+      def user=(user)
+        @user = user
+      end
+
+      def user
+        @user
+      end
+
+      def password=(password)
+        @password = password
+      end
+
+      def password
+        @password
+      end
+    end
+
+  end
+end

data/lib/lady_gaga/dial_a_zip.rb

@@ -0,0 +1,28 @@
+module LadyGaga
+  class DialAZip < Request
+
+    base_uri 'dial-a-zip.com'
+
+    protected
+
+    def default_options
+      {'COMMAND' => 'ZIP1'}
+    end
+    
+    def credentials
+      {'USER' => Config.user, 'PASSWORD' => Config.password}
+    end
+
+    def xml_root
+      'VERIFYADDRESS'
+    end
+
+    def xml_param
+      'input'
+    end
+
+    def path
+      '/XML-Dial-A-ZIP/DAZService.asmx/MethodZIPValidate'
+    end
+  end
+end

data/lib/lady_gaga/request.rb

@@ -0,0 +1,47 @@
+require 'httparty'
+require 'activesupport'
+
+module LadyGaga
+  class Request
+
+    include HTTParty
+
+    format :xml
+
+    attr_accessor :xml_path, :xml_root, :path, :credentials
+    
+    def default_options
+      {}
+    end
+
+    def credentials
+      {}
+    end
+
+    def options
+      @options ||= default_options
+    end
+
+    def <<(hash)
+      options.merge!(hash)
+    end
+
+    def reset!
+      @options = default_options
+    end
+
+    def body
+      {xml_param => options.merge(credentials).to_xml(:root => xml_root, :skip_instruct => true)}
+    end
+
+    def get
+      response = self.class.get(path, :query => body)
+      Response.new(response)
+    end
+    
+    def post
+      response = self.class.post(path, :body => body)
+      Response.new(response)
+    end
+  end
+end

data/lib/lady_gaga/response.rb

@@ -0,0 +1,36 @@
+require 'nokogiri'
+
+module LadyGaga
+  class Response
+
+    def initialize(response)
+      @response = response
+    end
+
+    def body
+      response.body
+    end
+
+    def to_h
+      response.to_hash
+    end
+
+    def code
+      response.code
+    end
+
+    def valid?
+      code == 200
+    end
+
+    def xml
+      @xml ||= Nokogiri::XML(body)
+    end
+
+    protected
+
+    def response
+      @response
+    end
+  end
+end

data/lib/lady_gaga/version.rb

@@ -0,0 +1,3 @@
+module LadyGaga
+  VERSION = "0.0.1"
+end

data/spec/config_spec.rb

@@ -0,0 +1,39 @@
+require 'spec_helper'
+
+module LadyGaga
+  describe LadyGaga do
+
+    subject { Config }
+
+    describe ".user" do
+      it "sets the @user class variable" do
+        Config.instance_variable_set(:@user, '12345')
+        Config.user.should == '12345'
+      end
+    end
+    
+    describe ".user=" do
+      it "sets the @user class variable" do
+        Config.user = '6789'
+        Config.instance_variable_get(:@user).should == '6789'
+      end
+    end
+
+
+    describe ".password" do
+      it "sets the @password class variable" do
+        Config.instance_variable_set(:@password, 'password')
+        Config.password.should == 'password'
+      end
+    end
+    
+    describe ".password=" do
+      it "sets the @password class variable" do
+        Config.password = 'new_password'
+        Config.instance_variable_get(:@password).should == 'new_password'
+      end
+    end
+
+    
+  end
+end

data/spec/dial_a_zip_spec.rb

@@ -0,0 +1,30 @@
+require 'spec_helper'
+
+module LadyGaga
+  describe DialAZip do
+
+    subject { DialAZip }
+
+    let(:request) { subject.new }
+
+    let(:credentials) do
+      {'USER' => '1234', 'PASSWORD' => 'password'}
+    end
+
+    before(:each) do
+      request.stub(:credentials).and_return(credentials)
+    end
+    
+    describe "#post" do
+
+      before(:each) do
+        subject.stub(:post).and_return('')
+      end
+      
+      it "returns a response object" do
+        request.post.should be_a(Response)
+      end
+    end
+  end
+
+end

data/spec/lady_gaga_spec.rb

@@ -0,0 +1,10 @@
+require 'spec_helper'
+
+describe LadyGaga do
+  subject { LadyGaga }
+
+  describe "#configure" do
+    it "yields the LadyGaga::Config file" do
+    end
+  end
+end

data/spec/request_spec.rb

@@ -0,0 +1,78 @@
+require 'spec_helper'
+
+module LadyGaga
+  describe Request do
+
+    subject { Request }
+
+    let(:path) { 'http://someurl.com' }
+    let(:xml_param) { 'q' }
+    let(:xml_root)  { 'root' }
+
+    let(:default_options) do
+      {'USER' => '1234', 'PASSWORD' => 'password'}
+    end
+
+    before(:each) do
+      @request = subject.new
+    end
+
+    describe '#default_options' do
+      it 'defaults to an empty hash' do
+        @request.default_options.should eql({})
+      end
+    end
+
+    describe '#options' do
+      it 'defaults to the default_options' do
+        @request.stub(:default_options).and_return(default_options)
+        @request.options.should === default_options
+      end
+    end
+
+    describe '#<<' do
+      it "merges a hash into the existing options" do
+        @request << {:foo => "bar"}
+        @request.options[:foo].should == "bar"
+      end
+    end
+
+    describe '#reset!' do
+      it "resets the parameters to a blank hash" do
+        @request << {:foo => 'bar'}
+        @request.reset!
+        @request.options.should_not have_key(:foo)
+      end
+    end
+
+    context "making a request" do
+
+      before(:each) do
+        @request.stub(:path).and_return(path)
+        @request.stub(:xml_param).and_return(xml_param)
+        @request.stub(:xml_root).and_return(xml_root)
+      end
+
+      describe '#post' do
+        before(:each) do
+          subject.stub(:post).and_return('')
+        end
+
+        it 'returns a Response object' do
+          @request.post.should be_a(Response)
+        end
+      end
+
+      describe '#get' do
+        before(:each) do
+          subject.stub(:get).and_return('')
+        end
+
+        it 'returns a Response object' do
+          @request.get.should be_a(Response)
+        end
+      end
+    end
+  end
+
+end

data/spec/response_spec.rb

@@ -0,0 +1,65 @@
+require 'spec_helper'
+
+module LadyGaga
+  describe Response do
+
+    let(:response) do
+      mock(HTTParty::Response)
+    end
+
+    subject { Response.new(response) }
+
+    describe "#body" do
+      it "calls the HTTParty::Response#body" do
+        response.should_receive(:body)
+        subject.body
+      end
+    end
+
+    describe "#to_h" do
+      it "calls the HTTParty::Response#to_hash" do
+        response.should_receive(:to_hash)
+        subject.to_h
+      end
+    end
+
+    describe "#code" do
+      it "calls the HTTParty::Response#code" do
+        response.should_receive(:code)
+        subject.code
+      end
+    end
+
+    describe "#valid?" do
+      context "code is 200" do
+        before(:each) do
+          subject.stub(:code).and_return(200)
+        end
+
+        it "returns true" do
+          subject.valid?.should be_true
+        end
+      end
+
+      context "code is not 200" do
+        before(:each) do
+          subject.stub(:code).and_return(500)
+        end
+
+        it "returns false" do
+          subject.valid?.should be_false
+        end
+      end
+    end
+
+    describe "#xml" do
+      before(:each) do
+        subject.stub(:body).and_return('')
+      end
+
+      it "returns a Nokogiri::XML document" do
+        subject.xml.should be_a(Nokogiri::XML::Document)
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,7 @@
+require 'rubygems'
+require 'bundler/setup'
+require 'rspec'
+
+require File.expand_path('../../lib/lady_gaga', __FILE__)
+
+Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each { |f| require f }

data/spec/support/endicia.yml.sample

@@ -0,0 +1,2 @@
+user: 'ENDICIA USER ID (e.g. 1234567)'
+password: 'ENDICIA PASSWORD'

data/spec/support/vcr.rb

@@ -0,0 +1,13 @@
+require 'vcr'
+
+VCR.config do |c|
+  c.cassette_library_dir     = File.dirname(__FILE__) + '/../fixtures/cassette_library'
+  c.default_cassette_options = {
+    :record             => :none,
+    :match_requests_on  => [:host] }
+  c.stub_with :webmock
+end
+
+RSpec.configure do |config|
+  config.extend VCR::RSpec::Macros
+end

metadata

@@ -0,0 +1,280 @@
+--- !ruby/object:Gem::Specification 
+name: lady_gaga
+version: !ruby/object:Gem::Version 
+  hash: 29
+  prerelease: 
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- Ryan Closner
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-06-23 00:00:00 -07:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: httparty
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 13
+        segments: 
+        - 0
+        - 7
+        - 7
+        version: 0.7.7
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: activesupport
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 23
+        segments: 
+        - 2
+        - 3
+        - 10
+        version: 2.3.10
+  type: :runtime
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: nokogiri
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 15
+        segments: 
+        - 1
+        - 4
+        - 4
+        version: 1.4.4
+  type: :runtime
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: relish
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 961915996
+        segments: 
+        - 0
+        - 3
+        - 0
+        - pre
+        version: 0.3.0.pre
+  type: :development
+  version_requirements: *id004
+- !ruby/object:Gem::Dependency 
+  name: rake
+  prerelease: false
+  requirement: &id005 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 49
+        segments: 
+        - 0
+        - 8
+        - 7
+        version: 0.8.7
+  type: :development
+  version_requirements: *id005
+- !ruby/object:Gem::Dependency 
+  name: addressable
+  prerelease: false
+  requirement: &id006 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - "="
+      - !ruby/object:Gem::Version 
+        hash: 15
+        segments: 
+        - 2
+        - 2
+        - 4
+        version: 2.2.4
+  type: :development
+  version_requirements: *id006
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id007 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 27
+        segments: 
+        - 2
+        - 5
+        - 0
+        version: 2.5.0
+  type: :development
+  version_requirements: *id007
+- !ruby/object:Gem::Dependency 
+  name: vcr
+  prerelease: false
+  requirement: &id008 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 51
+        segments: 
+        - 1
+        - 9
+        - 0
+        version: 1.9.0
+  type: :development
+  version_requirements: *id008
+- !ruby/object:Gem::Dependency 
+  name: bundler
+  prerelease: false
+  requirement: &id009 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 23
+        segments: 
+        - 1
+        - 0
+        - 0
+        version: 1.0.0
+  type: :development
+  version_requirements: *id009
+- !ruby/object:Gem::Dependency 
+  name: cucumber
+  prerelease: false
+  requirement: &id010 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 55
+        segments: 
+        - 0
+        - 10
+        - 0
+        version: 0.10.0
+  type: :development
+  version_requirements: *id010
+- !ruby/object:Gem::Dependency 
+  name: webmock
+  prerelease: false
+  requirement: &id011 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 15
+        segments: 
+        - 1
+        - 6
+        - 0
+        version: 1.6.0
+  type: :development
+  version_requirements: *id011
+description: A minimalistic Ruby Wrapper to the Endicia API
+email: 
+- ryan.closner@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- .rvmrc
+- Gemfile
+- README.md
+- Rakefile
+- features/dial_a_zip.feature
+- features/step_definitions/dial_a_zip_steps.rb
+- features/step_definitions/lady_gaga_steps.rb
+- features/support/env.rb
+- features/support/vcr.rb
+- lady_gaga.gemspec
+- lib/lady_gaga.rb
+- lib/lady_gaga/config.rb
+- lib/lady_gaga/dial_a_zip.rb
+- lib/lady_gaga/request.rb
+- lib/lady_gaga/response.rb
+- lib/lady_gaga/version.rb
+- spec/config_spec.rb
+- spec/dial_a_zip_spec.rb
+- spec/lady_gaga_spec.rb
+- spec/request_spec.rb
+- spec/response_spec.rb
+- spec/spec_helper.rb
+- spec/support/endicia.yml.sample
+- spec/support/vcr.rb
+has_rdoc: true
+homepage: https://rubygems.org/gems/lady_gaga
+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: lady_gaga
+rubygems_version: 1.4.2
+signing_key: 
+specification_version: 3
+summary: A Ruby Wrapper to the Endicia API
+test_files: 
+- features/dial_a_zip.feature
+- features/step_definitions/dial_a_zip_steps.rb
+- features/step_definitions/lady_gaga_steps.rb
+- features/support/env.rb
+- features/support/vcr.rb
+- spec/config_spec.rb
+- spec/dial_a_zip_spec.rb
+- spec/lady_gaga_spec.rb
+- spec/request_spec.rb
+- spec/response_spec.rb
+- spec/spec_helper.rb
+- spec/support/endicia.yml.sample
+- spec/support/vcr.rb