board-client 0.3.0 → 0.99.0

data/.gitignore

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

data/.rspec

@@ -0,0 +1 @@
+--colour

data/.rvmrc

@@ -0,0 +1,47 @@
+#!/usr/bin/env bash
+
+# This is an RVM Project .rvmrc file, used to automatically load the ruby
+# development environment upon cd'ing into the directory
+
+# First we specify our desired <ruby>[@<gemset>], the @gemset name is optional.
+environment_id="ree-1.8.7-2011.03@board-client"
+
+#
+# Uncomment following line if you want options to be set only for given project.
+#
+# PROJECT_JRUBY_OPTS=( --1.9 )
+
+#
+# First we attempt to load the desired environment directly from the environment
+# file. This is very fast and efficient compared to running through the entire
+# CLI and selector. If you want feedback on which environment was used then
+# insert the word 'use' after --create as this triggers verbose mode.
+#
+if [[ -d "${rvm_path:-$HOME/.rvm}/environments" \
+  && -s "${rvm_path:-$HOME/.rvm}/environments/$environment_id" ]]
+then
+  \. "${rvm_path:-$HOME/.rvm}/environments/$environment_id"
+
+  if [[ -s "${rvm_path:-$HOME/.rvm}/hooks/after_use" ]]
+  then
+    . "${rvm_path:-$HOME/.rvm}/hooks/after_use"
+  fi
+else
+  # If the environment file has not yet been created, use the RVM CLI to select.
+  if ! rvm --create  "$environment_id"
+  then
+    echo "Failed to create RVM environment '${environment_id}'."
+    exit 1
+  fi
+fi
+
+#
+# If you use an RVM gemset file to install a list of gems (*.gems), you can have
+# it be automatically loaded. Uncomment the following and adjust the filename if
+# necessary.
+#
+# filename=".gems"
+# if [[ -s "$filename" ]] ; then
+#   rvm gemset import "$filename" | grep -v already | grep -v listed | grep -v complete | sed '/^$/d'
+# fi
+

data/Gemfile

@@ -1,9 +1,3 @@
 source "http://rubygems.org"
 
-gem "rest-client", "~> 1.6.1"
-gem "yajl-ruby", "~> 0.7.7"
-
-group :test do
-  gem "rspec", "~> 1.3.0"
-  gem "webmock", "~> 1.3.5"
-end
+gemspec

data/README.md

@@ -1,30 +1,76 @@
-# board-client
+# Board::Client
 
-    client = Board::Client.new('YOUR_API_KEY_HERE')
+## TODO
 
-## candidate searches
+* Organization / User update add organization to user or add user to organization
 
-    search = client.candidate_search(:keywords => "ruby",
-                                     :distance => 50,
-                                     :location => "Cincinnati, OH")
+## Usage
 
-iterate through current page of results
+    board = Board::Client.new('YOUR_API_KEY_HERE')
 
-    search.results.each do |result|
+### Search
 
-    end
+All methods named search return search object that support a few elements of convenience.  Each search API returns a similar format and supports similar options.
 
-iterate through all pages and yield result
+    search.results # current page of results
+    search.each_result { |result| p result } # iterate through all pages of results
+    search.total # total number of results
+    search.page # current page number
 
-    search.each_result do |result|
+### User Search
 
-    end
+    # should this mimic candidate search with keywords?
+    board.users.search(:email => "foo@bar.com")
 
-## invitations
+    # should this just be a special method?
+    board.users.find(42) # by id
+    board.users.find(:email => "foo@bar.com")
+    board.users.find(:email_md5 => "asdfasdf")
 
-    invitation = client.create_invitation(:first_name => "Michael",
-                                          :last_name  => "Jordan",
-                                          :email      => "michael.jordan@nike.com")
+### User Create
+
+    user = board.users.create(:email      => "foo@bar.com",
+                              :first_name => "Bob",
+                              :last_name  => "Smith")
+
+    user.email      # => "foo@bar.com"
+    user.first_name # => "Bob"
+    user.last_name  # => "Smith"
+    user.id         # => 42
+
+### Organization Search
+
+    board.organizations.search(:name => "Nike")
+
+### Organization Create
+
+    organization = board.organizations.create(:name => "Nike"
+                                              :url  => "http://nike.com")
+
+    organization.name # => "Nike"
+    organization.url  # => "http://nike.com"
+    organization.id   # => 9
+
+### Organization Add User
+
+    board.organizations.add_user(:organization_id => organization.id, :user_id => 42)
+
+### Candidate Search
+
+    board.candidates.search(:keywords => "ruby",
+                            :distance => 50,
+                            :location => "Cincinnati, OH")
+
+### Candidate Invitations
+
+    invitation = client.candidates.invitation(:first_name => "Michael",
+                                              :last_name  => "Jordan",
+                                              :email      => "michael.jordan@nike.com")
+
+    invitation.url        # => "https://board.recruitmilitary.com/invitations/abcdefghijklmnopqrstuvwxyz0123456789"
+    invitation.first_name # => "Michael"
+    invitation.last_name  # => "Jordan"
+    invitation.email      # => "michael.jordan@nike.com"
 
 ## Note on Patches/Pull Requests
 
@@ -38,4 +84,4 @@ iterate through all pages and yield result
 
 ## Copyright
 
-Copyright (c) 2010 Michael Guterl. See LICENSE for details.
+Copyright (c) 2011 Michael Guterl. See LICENSE for details

data/Rakefile

@@ -1,46 +1,6 @@
-require 'rubygems'
-require 'rake'
-
-begin
-  require 'jeweler'
-  Jeweler::Tasks.new do |gem|
-    gem.name = "board-client"
-    gem.summary = %Q{A ruby wrapper for the board platform}
-    gem.description = %Q{A ruby wrapper for the board platform.}
-    gem.email = "mguterl@gmail.com"
-    gem.homepage = "http://github.com/mguterl/board-client"
-    gem.authors = ["Michael Guterl"]
-    gem.add_dependency "rest-client", "~> 1.6.1"
-    gem.add_dependency "yajl-ruby", "~> 0.7.7"
-    gem.add_development_dependency "rspec", "~> 1.3.0"
-    gem.add_development_dependency "webmock", "~> 1.6.2"
-    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
-  end
-  Jeweler::GemcutterTasks.new
-rescue LoadError
-  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
-end
-
-require 'spec/rake/spectask'
-Spec::Rake::SpecTask.new(:spec) do |spec|
-  spec.libs << 'lib' << 'spec'
-  spec.spec_files = FileList['spec/**/*_spec.rb']
-end
-
-Spec::Rake::SpecTask.new(:rcov) do |spec|
-  spec.libs << 'lib' << 'spec'
-  spec.pattern = 'spec/**/*_spec.rb'
-  spec.rcov = true
-end
+require 'bundler'
+Bundler::GemHelper.install_tasks
 
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new
 task :default => :spec
-
-require 'rake/rdoctask'
-Rake::RDocTask.new do |rdoc|
-  version = File.exist?('VERSION') ? File.read('VERSION') : ""
-
-  rdoc.rdoc_dir = 'rdoc'
-  rdoc.title = "board-client #{version}"
-  rdoc.rdoc_files.include('README*')
-  rdoc.rdoc_files.include('lib/**/*.rb')
-end

data/board-client.gemspec

@@ -1,74 +1,30 @@
-# Generated by jeweler
-# DO NOT EDIT THIS FILE DIRECTLY
-# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
 # -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "board/client/version"
 
 Gem::Specification.new do |s|
-  s.name = %q{board-client}
-  s.version = "0.3.0"
+  s.name        = "board-client"
+  s.version     = Board::Client::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Michael Guterl"]
+  s.email       = ["mguterl@gmail.com"]
+  s.homepage    = "http://github.com/recruitmilitary/board-client"
+  s.summary     = %q{A ruby wrapper for the RecruitMilitary Board HTTP API}
+  s.description = %q{A ruby wrapper for the RecruitMilitary Board HTTP API}
 
-  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
-  s.authors = ["Michael Guterl"]
-  s.date = %q{2011-05-04}
-  s.description = %q{A ruby wrapper for the board platform.}
-  s.email = %q{mguterl@gmail.com}
-  s.extra_rdoc_files = [
-    "LICENSE",
-    "README.md"
-  ]
-  s.files = [
-    ".document",
-    "Gemfile",
-    "Gemfile.lock",
-    "LICENSE",
-    "README.md",
-    "Rakefile",
-    "VERSION",
-    "board-client.gemspec",
-    "lib/board-client.rb",
-    "lib/board/candidate_search.rb",
-    "lib/board/client.rb",
-    "lib/board/request.rb",
-    "spec/board/candidate_search_spec.rb",
-    "spec/board/client_spec.rb",
-    "spec/spec.opts",
-    "spec/spec_helper.rb"
-  ]
-  s.homepage = %q{http://github.com/mguterl/board-client}
+  s.rubyforge_project = "board-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.rubygems_version = %q{1.5.2}
-  s.summary = %q{A ruby wrapper for the board platform}
-  s.test_files = [
-    "spec/board/candidate_search_spec.rb",
-    "spec/board/client_spec.rb",
-    "spec/spec_helper.rb"
-  ]
 
-  if s.respond_to? :specification_version then
-    s.specification_version = 3
+  s.add_dependency 'rest-client', '~> 1.6.1'
+  s.add_dependency 'yajl-ruby',   '~> 0.7.7'
+  s.add_dependency 'hashie',      '~> 1.1.0'
 
-    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
-      s.add_runtime_dependency(%q<rest-client>, ["~> 1.6.1"])
-      s.add_runtime_dependency(%q<yajl-ruby>, ["~> 0.7.7"])
-      s.add_runtime_dependency(%q<rest-client>, ["~> 1.6.1"])
-      s.add_runtime_dependency(%q<yajl-ruby>, ["~> 0.7.7"])
-      s.add_development_dependency(%q<rspec>, ["~> 1.3.0"])
-      s.add_development_dependency(%q<webmock>, ["~> 1.6.2"])
-    else
-      s.add_dependency(%q<rest-client>, ["~> 1.6.1"])
-      s.add_dependency(%q<yajl-ruby>, ["~> 0.7.7"])
-      s.add_dependency(%q<rest-client>, ["~> 1.6.1"])
-      s.add_dependency(%q<yajl-ruby>, ["~> 0.7.7"])
-      s.add_dependency(%q<rspec>, ["~> 1.3.0"])
-      s.add_dependency(%q<webmock>, ["~> 1.6.2"])
-    end
-  else
-    s.add_dependency(%q<rest-client>, ["~> 1.6.1"])
-    s.add_dependency(%q<yajl-ruby>, ["~> 0.7.7"])
-    s.add_dependency(%q<rest-client>, ["~> 1.6.1"])
-    s.add_dependency(%q<yajl-ruby>, ["~> 0.7.7"])
-    s.add_dependency(%q<rspec>, ["~> 1.3.0"])
-    s.add_dependency(%q<webmock>, ["~> 1.6.2"])
-  end
+  s.add_development_dependency 'rspec', '~> 2.6.0'
+  s.add_development_dependency 'vcr', '~> 1.11.1'
+  s.add_development_dependency 'webmock', '~> 1.7.4'
+  s.add_development_dependency 'ruby-debug'
 end
-

data/lib/board/client.rb

@@ -1,45 +1,64 @@
 require 'yajl'
+require 'hashie/mash'
 
-require 'board/request'
-require 'board/candidate_search'
+require 'board/client/version'
+require 'board/client/request'
 
 module Board
   class Client
 
-    include Request
+    class Error < StandardError
+      attr_reader :response
 
-    class << self
-      attr_accessor :default_url
+      def initialize(response)
+        @response = response
+      end
     end
-    self.default_url = 'https://board.recruitmilitary.com/api/v1'
 
-    def initialize(api_key, url = Client.default_url)
-      @api_key = api_key
-      @url     = url
-    end
+    BadRequest          = Class.new(Error)
+    Unauthorized        = Class.new(Error)
+    Forbidden           = Class.new(Error)
+    NotFound            = Class.new(Error)
+    NotAcceptable       = Class.new(Error)
+    Conflict            = Class.new(Error)
+    UnprocessableEntity = Class.new(Error)
+    InternalServerError = Class.new(Error)
+    NotImplemented      = Class.new(Error)
+    BadGateway          = Class.new(Error)
+    ServiceUnavailable  = Class.new(Error)
 
-    def candidate_searches(params)
-      get "/candidate_searches", params
+    include Request
+
+    class << self
+      attr_accessor :default_endpoint
     end
+    self.default_endpoint = 'https://board.recruitmilitary.com/api/v1'
 
-    def find_user(params)
-      get "/users", params
+    def initialize(api_key, endpoint = Client.default_endpoint)
+      @api_key  = api_key
+      @endpoint = endpoint
     end
 
-    def mark_user_invalid(params)
-      get "/users/invalid", params
+    autoload :API, 'board/client/api'
+    autoload :Users, 'board/client/users'
+    autoload :Candidates, 'board/client/candidates'
+    autoload :Organizations, 'board/client/organizations'
+    autoload :UserOrganizations, 'board/client/user_organizations'
+
+    def users
+      Users.new(self)
     end
 
-    def unsubscribe(params)
-      get "/users/unsubscribe", params
+    def candidates
+      Candidates.new(self)
     end
 
-    def create_candidate_invitation(params)
-      post "/candidate_invitations", params
+    def organizations
+      Organizations.new(self)
     end
 
-    def find_candidate(candidate_id)
-      get "/candidates/#{candidate_id}", {}
+    def user_organizations
+      UserOrganizations.new(self)
     end
 
   end

data/lib/board/client/api.rb

@@ -0,0 +1,29 @@
+module Board
+  class Client::API
+
+    def initialize(client)
+      @client = client
+    end
+
+    def post(path, attributes = {})
+      json = @client.post(path, attributes)
+
+      if json.is_a?(Hash)
+        Hashie::Mash.new(json)
+      else
+        json
+      end
+    end
+
+    def get(path, attributes = {})
+      json = @client.get(path, attributes)
+
+      if json.is_a?(Array)
+        json.map { |item| Hashie::Mash.new(item) }
+      else
+        Hashie::Mash.new(json)
+      end
+    end
+
+  end
+end

data/lib/board/client/candidates.rb

@@ -0,0 +1,13 @@
+module Board
+  class Client::Candidates < Client::API
+
+    def find(id)
+      get("/candidates/#{id}")
+    end
+
+    def invite(attributes)
+      post("/candidate_invitations", attributes)
+    end
+
+  end
+end

data/lib/board/client/organizations.rb

@@ -0,0 +1,17 @@
+module Board
+  class Client::Organizations < Client::API
+
+    def create(attributes)
+      post("/organizations", attributes)
+    end
+
+    def find(id)
+      if id.is_a?(Hash)
+        get("/organizations", id)
+      else
+        get("/organizations/#{id}")
+      end
+    end
+
+  end
+end