board-client 0.1.0 → 0.2.0

data/VERSION

@@ -1 +1 @@
-0.1.0
+0.2.0

data/board-client.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{board-client}
-  s.version = "0.1.0"
+  s.version = "0.2.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Michael Guterl"]
-  s.date = %q{2011-04-05}
+  s.date = %q{2011-05-03}
   s.description = %q{A ruby wrapper for the board platform.}
   s.email = %q{mguterl@gmail.com}
   s.extra_rdoc_files = [
@@ -26,16 +26,10 @@ Gem::Specification.new do |s|
     "VERSION",
     "board-client.gemspec",
     "lib/board-client.rb",
-    "lib/board/api.rb",
-    "lib/board/api/base.rb",
-    "lib/board/api/candidate_invitations.rb",
-    "lib/board/api/candidate_searches.rb",
-    "lib/board/api/users.rb",
     "lib/board/candidate_search.rb",
     "lib/board/client.rb",
-    "spec/board/api/candidate_invitations_spec.rb",
-    "spec/board/api/candidate_searches_spec.rb",
-    "spec/board/api/users_spec.rb",
+    "lib/board/request.rb",
+    "spec/board/candidate_search_spec.rb",
     "spec/board/client_spec.rb",
     "spec/spec.opts",
     "spec/spec_helper.rb"
@@ -45,9 +39,7 @@ Gem::Specification.new do |s|
   s.rubygems_version = %q{1.5.2}
   s.summary = %q{A ruby wrapper for the board platform}
   s.test_files = [
-    "spec/board/api/candidate_invitations_spec.rb",
-    "spec/board/api/candidate_searches_spec.rb",
-    "spec/board/api/users_spec.rb",
+    "spec/board/candidate_search_spec.rb",
     "spec/board/client_spec.rb",
     "spec/spec_helper.rb"
   ]

data/lib/board/candidate_search.rb

@@ -1,69 +1,44 @@
 module Board
 
-  class CandidateSearch < API::Base
+  class CandidateSearch
 
-    DEFAULT_PER_PAGE = 10
-
-    attr_reader :params
-
-    def initialize(*args)
-      @params = args.pop
-      self.page = params[:page] || 1
-      super
-    end
-
-    def each_result
-      (1..total_pages).each do |page|
-        self.page = page
-        results.each do |result|
-          yield result
-        end
-        clear
-      end
-    end
+    attr_reader :errors
 
-    def total_pages
-      (total / per_page.to_f).ceil
+    def initialize(client, params = {})
+      @client = client
+      @params = params
+      @errors = []
     end
 
     def results
-      response['results']
-    end
-
-    def total
-      response['total']
+      initial_search['results']
     end
 
-    def per_page
-      params[:per_page] || DEFAULT_PER_PAGE
-    end
+    def each_result
+      total = initial_search['total']
+      pages = (total / 10.0).ceil
 
-    def page
-      params[:page]
-    end
+      initial_search['results'].each { |r| yield r }
 
-    def page=(value)
-      params[:page] = value
+      (2..pages).each do |page|
+        search = @client.candidate_searches(@params.merge(:page => page))
+        results = search['results']
+        results.each { |r| yield r }
+      end
     end
 
     def valid?
-      response && (errors.nil? || errors.size == 0)
+      perform_search and @errors.empty?
     end
 
-    attr_reader :errors
-
     private
 
-    def clear
-      @response = nil
-      @errors   = nil
-    end
-
-    def response
-      @response ||= get "/candidate_searches", params
-    rescue RestClient::Exception => e
-      @errors = decode_json(e.response)
+    def initial_search
+      @initial_search ||= @client.candidate_searches(@params)
+    rescue Board::Request::Error => e
+      @errors = Yajl::Parser.parse(e.response.body)
     end
+    alias perform_search initial_search
 
   end
 

data/lib/board/client.rb

@@ -1,17 +1,13 @@
-require 'rubygems'
-require 'bundler/setup'
-
-require 'rest_client'
 require 'yajl'
 
-require 'board/api'
+require 'board/request'
+require 'board/candidate_search'
 
 module Board
-
-  autoload :CandidateSearch, 'board/candidate_search'
-
   class Client
 
+    include Request
+
     class << self
       attr_accessor :default_url
     end
@@ -22,18 +18,29 @@ module Board
       @url     = url
     end
 
-    def candidate_invitations
-      @candidate_invitations ||= API::CandidateInvitations.new(@api_key, @url)
+    def candidate_searches(params)
+      get "/candidate_searches", params
     end
 
-    def users
-      @users ||= API::Users.new(@api_key, @url)
+    def find_user(params)
+      get "/users", params
     end
 
-    def candidate_search(params)
-      API::CandidateSearches.new(@api_key, @url).create(params)
+    def mark_user_invalid(params)
+      get "/users/invalid", params
     end
 
-  end
+    def unsubscribe(params)
+      get "/users/unsubscribe", params
+    end
 
+    def create_candidate_invitation(params)
+      post "/candidate_invitations", params
+    end
+
+    def find_candidate(candidate_id)
+      get "/candidates/#{candidate_id}", {}
+    end
+
+  end
 end

data/lib/board/request.rb

@@ -0,0 +1,68 @@
+module Board
+  module Request
+
+    class Error < StandardError
+      attr_reader :response
+
+      def initialize(response)
+        @response = response
+      end
+    end
+
+    private
+
+    def post(path, params)
+      request path, params, :post
+    end
+
+    def get(path, params)
+      request path, params, :get
+    end
+
+    def request(path, params, method)
+      params.merge!(:user_credentials => @api_key)
+
+      response = case method
+                 when :get
+                   uri = URI.parse(@url + path + "?" + hash_to_query_string(params))
+                   Net::HTTP.get_response(uri)
+                 when :post
+                   uri = URI.parse(@url + path)
+                   Net::HTTP.post_form(uri, params)
+                 end
+
+      if response.code =~ /2../
+        Yajl::Parser.parse(response.body)
+      else
+        raise Error.new(response)
+      end
+    end
+
+    def hash_to_query_string(hash)
+      params = ''
+      stack = []
+
+      hash.each do |k, v|
+        if v.is_a?(Hash)
+          stack << [k,v]
+        else
+          params << "#{k}=#{v}&"
+        end
+      end
+
+      stack.each do |parent, hash|
+        hash.each do |k, v|
+          if v.is_a?(Hash)
+            stack << ["#{parent}[#{k}]", v]
+          else
+            params << "#{parent}[#{k}]=#{v}&"
+          end
+        end
+      end
+
+      params.chop! # trailing &
+      params
+    end
+
+  end
+end

data/spec/board/{api/candidate_searches_spec.rb → candidate_search_spec.rb}

@@ -1,80 +1,42 @@
 require 'spec_helper'
 
-describe Board::API::CandidateSearches do
+describe Board::CandidateSearch do
 
+  let(:search) { Board::CandidateSearch.new(client, :keywords => 'ruby') }
   let(:client) { Board::Client.new('VALID_KEY') }
 
   before do
-    stub_request(:get, "https://board.recruitmilitary.com/api/v1/candidate_searches").
-      with(:query => {
-             'user_credentials' => 'VALID_KEY',
-             'keywords'         => 'ruby',
-             'page'     => '1',
-           }).
+    stub_request(:get, "http://board.recruitmilitary.com:443/api/v1/candidate_searches?keywords=ruby&user_credentials=VALID_KEY").
       to_return(:body => %q{{"results":[{"email":"candidate@recruitmilitary.com","zip_code":null,"last_activity_at":"2010-11-24T14:13:26Z","phone":null,"state":"OH","last_name":"Smith","first_name":"Rodolfo","resume_url":null,"location":"Hagenesside, OH","city":"Hagenesside"},{"email":"benton@effertz.info","zip_code":null,"last_activity_at":"2010-11-16T14:13:26Z","phone":null,"state":"OH","last_name":"Bins","first_name":"Alfred","resume_url":null,"location":"East Elizabeth, OH","city":"East Elizabeth"},{"email":"melba@armstrong.us","zip_code":null,"last_activity_at":"2010-11-22T14:13:27Z","phone":null,"state":"OH","last_name":"Pouros","first_name":"Warren","resume_url":null,"location":"Margemouth, OH","city":"Margemouth"},{"email":"yvette@lynch.name","zip_code":null,"last_activity_at":"2010-11-25T14:13:27Z","phone":null,"state":"OH","last_name":"Denesik","first_name":"Isai","resume_url":null,"location":"Lake Othaton, OH","city":"Lake Othaton"},{"email":"hipolito.mosciski@schoenbrown.uk","zip_code":null,"last_activity_at":"2010-11-25T14:13:28Z","phone":null,"state":"OH","last_name":"Paucek","first_name":"Cristina","resume_url":"https://localhost/resumes/1/resume.pdf","location":"East Aiden, OH","city":"East Aiden"},{"email":"lydia@cassin.name","zip_code":null,"last_activity_at":"2010-11-13T14:13:29Z","phone":null,"state":"OH","last_name":"Johnson","first_name":"Marianna","resume_url":null,"location":"Bartonhaven, OH","city":"Bartonhaven"},{"email":"gabe@price.ca","zip_code":null,"last_activity_at":"2010-11-16T14:13:29Z","phone":null,"state":"OH","last_name":"Wolf","first_name":"Idell","resume_url":"https://localhost/resumes/2/resume.pdf","location":"South Angelinestad, OH","city":"South Angelinestad"},{"email":"monserrat_douglas@zemlakbrekke.biz","zip_code":null,"last_activity_at":"2010-11-16T14:13:30Z","phone":null,"state":"OH","last_name":"Shanahan","first_name":"Zelda","resume_url":null,"location":"Mosesstad, OH","city":"Mosesstad"},{"email":"vada.hauck@gaylordbosco.co.uk","zip_code":null,"last_activity_at":"2010-11-12T14:13:30Z","phone":null,"state":"OH","last_name":"Bergstrom","first_name":"Anabelle","resume_url":null,"location":"Cliffordhaven, OH","city":"Cliffordhaven"},{"email":"maeve@abernathywaelchi.info","zip_code":null,"last_activity_at":"2010-12-01T14:13:31Z","phone":null,"state":"OH","last_name":"Gibson","first_name":"Rubie","resume_url":null,"location":"New Tre, OH","city":"New Tre"}],"page":1,"total":15}})
-    stub_request(:get, "https://board.recruitmilitary.com/api/v1/candidate_searches").
-      with(:query => {
-             'user_credentials' => 'VALID_KEY',
-             'keywords'         => 'ruby',
-             'page'     => '2',
-           }).
+    stub_request(:get, "http://board.recruitmilitary.com:443/api/v1/candidate_searches?keywords=ruby&page=2&user_credentials=VALID_KEY").
       to_return(:body => %q{{"results":[{"email":"candidate@recruitmilitary.com","zip_code":null,"last_activity_at":"2010-11-24T14:13:26Z","phone":null,"state":"OH","last_name":"Smith","first_name":"Rodolfo","resume_url":null,"location":"Hagenesside, OH","city":"Hagenesside"},{"email":"benton@effertz.info","zip_code":null,"last_activity_at":"2010-11-16T14:13:26Z","phone":null,"state":"OH","last_name":"Bins","first_name":"Alfred","resume_url":null,"location":"East Elizabeth, OH","city":"East Elizabeth"},{"email":"melba@armstrong.us","zip_code":null,"last_activity_at":"2010-11-22T14:13:27Z","phone":null,"state":"OH","last_name":"Pouros","first_name":"Warren","resume_url":null,"location":"Margemouth, OH","city":"Margemouth"},{"email":"yvette@lynch.name","zip_code":null,"last_activity_at":"2010-11-25T14:13:27Z","phone":null,"state":"OH","last_name":"Denesik","first_name":"Isai","resume_url":null,"location":"Lake Othaton, OH","city":"Lake Othaton"},{"email":"hipolito.mosciski@schoenbrown.uk","zip_code":null,"last_activity_at":"2010-11-25T14:13:28Z","phone":null,"state":"OH","last_name":"Paucek","first_name":"Cristina","resume_url":"https://localhost/resumes/1/resume.pdf","location":"East Aiden, OH","city":"East Aiden"}],"page":2,"total":15}})
-    stub_request(:get, "https://board.recruitmilitary.com/api/v1/candidate_searches").
-      with(:query => {
-             'user_credentials' => 'VALID_KEY',
-             'per_page'         => '501',
-             'page'     => '1',
-           }).
+    stub_request(:get, "http://board.recruitmilitary.com:443/api/v1/candidate_searches?per_page=501&user_credentials=VALID_KEY").
       to_return(:body   => %q{[["per_page", "must be less than or equal to 500"]]},
                 :status => 422)
   end
 
   describe "searching", "when valid" do
-
-    let(:search) { client.candidate_search(:keywords => "ruby") }
-
-    it 'is valid' do
-      search.should be_valid
-    end
-
-    it 'returns the number of search results' do
-      search.total.should == 15
-    end
-
-    it 'returns the page' do
-      search.page.should == 1
-    end
-
     it 'returns the correct number of results' do
       search.results.size.should == 10
     end
 
-    it 'returns the correct number of total pages' do
-      search.total_pages.should == 2
-    end
-
     it 'iterates through all results' do
       results = []
       search.each_result do |result|
         results << result
       end
-      results.size.should == search.total
+      results.size.should == 15
     end
-
   end
 
   describe "searching", "when invalid" do
-
-    let(:search) { client.candidate_search(:per_page => 501) }
-
-    before do
-      search.should_not be_valid
-    end
+    let(:search) { Board::CandidateSearch.new(client, :per_page => '501') }
 
     it 'returns a collection of errors' do
+      search.valid?
+
       search.errors.should == [["per_page", "must be less than or equal to 500"]]
     end
-
   end
 
 end

data/spec/board/client_spec.rb

@@ -1,11 +1,32 @@
 require 'spec_helper'
 
+module RequestTracking
+
+  class Request < Struct.new(:path, :params, :method); end
+
+  def request(path, params, method)
+    requests << Request.new(path, params, method)
+  end
+
+  def requests
+    @requests ||= []
+  end
+
+end
+
 describe Board::Client do
 
-  let(:client) { Board::Client.new('VALID_KEY') }
+  let(:client) {
+    client = Board::Client.new('VALID_KEY')
+    client.extend(RequestTracking)
+    client
+  }
 
-  describe "when creating" do
+  def last_request
+    @last_request ||= client.requests.last
+  end
 
+  describe "when creating" do
     context 'and missing an API key' do
       it 'should raise an error' do
         expect { Board::Client.new }.to raise_error
@@ -17,7 +38,69 @@ describe Board::Client do
         Board::Client.new('API_KEY')
       end
     end
+  end
+
+  describe '#candidate_searches' do
+    it 'performs the correct request' do
+      client.candidate_searches(:keywords => 'ruby', :location => 'Cincinnati')
+
+      last_request.path.should == '/candidate_searches'
+      last_request.method.should == :get
+      last_request.params.should == {
+        :keywords => "ruby",
+        :location => "Cincinnati",
+      }
+    end
+  end
+
+  describe '#find_user' do
+    it 'performs the correct request' do
+      client.find_user(:email => 'bob@rm.com')
+
+      last_request.path.should == '/users'
+      last_request.method.should == :get
+      last_request.params.should == { :email => 'bob@rm.com' }
+    end
+  end
 
+  describe '#mark_user_invalid' do
+    it 'performs the correct request' do
+      client.mark_user_invalid(:email => 'bob@rm.com')
+
+      last_request.path.should == '/users/invalid'
+      last_request.method.should == :get
+      last_request.params.should == { :email => 'bob@rm.com' }
+    end
+  end
+
+  describe '#unsubscribe' do
+    it 'performs the correct request' do
+      client.unsubscribe(:email => 'bob@rm.com')
+
+      last_request.path.should == '/users/unsubscribe'
+      last_request.method.should == :get
+      last_request.params.should == { :email => 'bob@rm.com' }
+    end
+  end
+
+  describe '#create_candidate_invitation' do
+    it 'performs the correct request' do
+      client.create_candidate_invitation(:email => 'bob@rm.com')
+
+      last_request.path.should == '/candidate_invitations'
+      last_request.method.should == :post
+      last_request.params.should == { :email => 'bob@rm.com' }
+    end
+  end
+
+  describe '#candidates' do
+    it 'performs the correct request' do
+      client.find_candidate(42)
+
+      last_request.path.should == '/candidates/42'
+      last_request.method.should == :get
+      last_request.params.should == {}
+    end
   end
 
 end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: board-client
 version: !ruby/object:Gem::Version 
-  hash: 27
+  hash: 23
   prerelease: 
   segments: 
   - 0
-  - 1
+  - 2
   - 0
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors: 
 - Michael Guterl
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-04-05 00:00:00 -04:00
+date: 2011-05-03 00:00:00 -04:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -133,16 +133,10 @@ files:
 - VERSION
 - board-client.gemspec
 - lib/board-client.rb
-- lib/board/api.rb
-- lib/board/api/base.rb
-- lib/board/api/candidate_invitations.rb
-- lib/board/api/candidate_searches.rb
-- lib/board/api/users.rb
 - lib/board/candidate_search.rb
 - lib/board/client.rb
-- spec/board/api/candidate_invitations_spec.rb
-- spec/board/api/candidate_searches_spec.rb
-- spec/board/api/users_spec.rb
+- lib/board/request.rb
+- spec/board/candidate_search_spec.rb
 - spec/board/client_spec.rb
 - spec/spec.opts
 - spec/spec_helper.rb
@@ -181,8 +175,6 @@ signing_key:
 specification_version: 3
 summary: A ruby wrapper for the board platform
 test_files: 
-- spec/board/api/candidate_invitations_spec.rb
-- spec/board/api/candidate_searches_spec.rb
-- spec/board/api/users_spec.rb
+- spec/board/candidate_search_spec.rb
 - spec/board/client_spec.rb
 - spec/spec_helper.rb

data/lib/board/api/base.rb

@@ -1,49 +0,0 @@
-module Board
-  module API
-
-    class Base
-
-      def initialize(api_key, base_url)
-        @api_key  = api_key
-        @base_url = base_url
-      end
-
-      private
-
-      def get(*args)
-        request(:get, *args)
-      end
-
-      def post(*args)
-        request(:post, *args)
-      end
-
-      def request(http_method, *args)
-        path   = args.shift
-        params = args.shift.merge(:user_credentials => @api_key)
-        url    = @base_url + path
-
-        response = case http_method
-        when :get
-          RestClient.get(url, { :params => params, :accept => :json })
-        when :post
-          RestClient.post(url, encode_json(params), :content_type => :json, :accept => :json)
-        else
-          raise ArgumentError, "unknown http method: #{http_method}"
-        end
-
-        decode_json(response.body)
-      end
-
-      def encode_json(obj)
-        Yajl::Encoder.encode(obj)
-      end
-
-      def decode_json(json)
-        Yajl::Parser.parse(json)
-      end
-
-    end
-
-  end
-end

data/lib/board/api/candidate_invitations.rb

@@ -1,11 +0,0 @@
-module Board::API
-
-  class CandidateInvitations < Base
-
-    def create(params)
-      post "/candidate_invitations", params
-    end
-
-  end
-
-end

data/lib/board/api/candidate_searches.rb

@@ -1,11 +0,0 @@
-module Board::API
-
-  class CandidateSearches < Base
-
-    def create(params)
-      Board::CandidateSearch.new(@api_key, @base_url, params)
-    end
-
-  end
-
-end

data/lib/board/api/users.rb

@@ -1,21 +0,0 @@
-module Board
-  module API
-
-    class Users < Base
-
-      def find(params)
-        get "/users", params
-      end
-
-      def unsubscribe(params)
-        get "/users/unsubscribe", params
-      end
-
-      def invalid(params)
-        get "/users/invalid", params
-      end
-
-    end
-
-  end
-end

data/lib/board/api.rb

@@ -1,10 +0,0 @@
-module Board
-  module API
-
-    autoload :Base,                 'board/api/base'
-    autoload :CandidateInvitations, 'board/api/candidate_invitations'
-    autoload :Users,                'board/api/users'
-    autoload :CandidateSearches,    'board/api/candidate_searches'
-
-  end
-end

data/spec/board/api/candidate_invitations_spec.rb

@@ -1,40 +0,0 @@
-require 'spec_helper'
-
-describe Board::API::CandidateInvitations do
-
-  let(:client) { Board::Client.new('VALID_KEY') }
-
-  before do
-    stub_request(:post, "https://board.recruitmilitary.com/api/v1/candidate_invitations").
-      with(:body => {
-             "first_name" => "Michael",
-             "email" => "michael.jordan@nike.com",
-             "last_name" => "Jordan",
-             "user_credentials" => "VALID_KEY"}).
-      to_return(:body => %q{{"created_at":"2010-09-21T17:51:23Z","accepted_at":null,"updated_at":"2010-09-21T17:51:23Z","secret_id":"5991a3d7c0fdfe0b6fa659ff8b5de18d","id":3,"last_name":"bar","organization_id":null,"first_name":"foo","email":"foo@bar.com"}})
-  end
-
-  describe "#create" do
-
-    context 'when successful' do
-      it 'should return a hash representing the saved invitation' do
-        response = client.candidate_invitations.create(:first_name => "Michael",
-                                                       :last_name  => "Jordan",
-                                                       :email      => "michael.jordan@nike.com")
-        response.should == {
-          "id"              => 3,
-          "first_name"      => "foo",
-          "last_name"       => "bar",
-          "email"           => "foo@bar.com",
-          "secret_id"       => "5991a3d7c0fdfe0b6fa659ff8b5de18d",
-          "organization_id" => nil,
-          "accepted_at"     => nil,
-          "created_at"      => "2010-09-21T17:51:23Z",
-          "updated_at"      => "2010-09-21T17:51:23Z",
-        }
-      end
-    end
-
-  end
-
-end

data/spec/board/api/users_spec.rb

@@ -1,49 +0,0 @@
-require 'spec_helper'
-
-describe Board::API::Users do
-
-  let(:client) { Board::Client.new('VALID_KEY') }
-
-  before do
-    stub_request(:get, "https://board.recruitmilitary.com/api/v1/users?email=jerry@seinfeld.com&user_credentials=VALID_KEY").
-      to_return(:body => %q{[{"id":1,"last_name":"Seinfeld","first_name":"Jerry","email":"jerry@seinfeld.com"}]})
-
-    stub_request(:get, "https://board.recruitmilitary.com/api/v1/users/unsubscribe?email=jerry@seinfeld.com&user_credentials=VALID_KEY").
-      to_return(:body => %q{{"unsubscribed_at":"2010-11-17T15:09:57-05:00"}})
-
-    stub_request(:get, "https://board.recruitmilitary.com/api/v1/users/invalid?email=jerry@seinfeld.com&user_credentials=VALID_KEY").
-      to_return(:body => %q{{"email_invalid_at":"2010-11-17T15:09:57-05:00"}})
-  end
-
-  describe "#find" do
-
-    it 'should return an array of hashes' do
-      response = client.users.find(:email => 'jerry@seinfeld.com')
-
-      response.should == [{ "id" => 1,
-                            "last_name" => "Seinfeld",
-                            "first_name" => "Jerry",
-                            "email" => "jerry@seinfeld.com"}]
-    end
-
-  end
-
-  describe "#unsubscribe" do
-
-    it 'should return a date' do
-      response = client.users.unsubscribe(:email => 'jerry@seinfeld.com')
-
-      response.should == { 'unsubscribed_at' => "2010-11-17T15:09:57-05:00" }
-    end
-
-  end
-
-  describe "#invalid" do
-    it 'returns the date the user was marked invalid' do
-      response = client.users.invalid(:email => 'jerry@seinfeld.com')
-
-      response.should == { 'email_invalid_at' => '2010-11-17T15:09:57-05:00' }
-    end
-  end
-
-end