zip_recruiter 1.0.1

data/.gitignore

@@ -0,0 +1,18 @@
+*.gem
+*.rbc
+.bundle
+.config
+.rvmrc
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format progress

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Adam Dunson
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,44 @@
+# ZipRecruiter
+
+Provides a CLI and ruby interface to the ZipRecruiter Job Alerts API.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'zip_recruiter'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install zip_recruiter
+
+## Usage
+
+Run the following to display CLI usage:
+
+    $ ziprecruiter
+
+Additionally, you may use the ZipRecruiter::API class directly in a ruby
+script.
+
+    require 'zip_recruiter'
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request
+
+## Notes
+
+There is a bug in Thor (see
+[issue 261](https://github.com/wycats/thor/issues/261)) where the help command
+for a subcommand will display the wrong name for the subcommand due to the way
+it generates the help output. E.g., `$ ziprecruiter jobalerts` shows
+`ziprecruiter c_l_i` in the output.

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/bin/ziprecruiter

@@ -0,0 +1,3 @@
+#!/usr/bin/env ruby
+require 'zip_recruiter/cli'
+ZipRecruiter::CLI.start

data/lib/zip_recruiter.rb

@@ -0,0 +1,4 @@
+require 'zip_recruiter/version'
+
+module ZipRecruiter
+end

data/lib/zip_recruiter/api.rb

@@ -0,0 +1,17 @@
+module ZipRecruiter
+  class API
+    ##
+    # Sets the API key
+    #
+    def self.api_key=(api_key)
+      @@api_key = api_key
+    end
+
+    ##
+    # Gets the API key
+    #
+    def self.api_key
+      @@api_key || ''
+    end
+  end
+end

data/lib/zip_recruiter/cli.rb

@@ -0,0 +1,8 @@
+require 'thor'
+require 'zip_recruiter/job_alerts/cli'
+
+module ZipRecruiter
+  class CLI < Thor
+    register ZipRecruiter::JobAlerts::CLI, 'jobalerts', 'jobalerts [COMMAND]', 'Type ziprecruiter jobalerts for more help.'
+  end
+end

data/lib/zip_recruiter/job_alerts.rb

@@ -0,0 +1,4 @@
+module ZipRecruiter
+  module JobAlerts
+  end
+end

data/lib/zip_recruiter/job_alerts/api.rb

@@ -0,0 +1,71 @@
+require 'curb'
+require 'zip_recruiter/api'
+
+module ZipRecruiter
+  module JobAlerts
+    class API < ZipRecruiter::API
+      ##
+      # Performs the specified API action.
+      #
+      # This will perform the specified API action. The action must be one of:
+      #
+      # * +subscribe+
+      # * +unsubscribe+
+      # * +status+
+      #
+      # The +subscribe+ and +unsubscribe+ actions require an argument that is the
+      # path to a CSV file. The +status+ action requires an argument that is the
+      # task ID of a previously submitted API request.
+      #
+      # You should not call this method directly, but instead use one of the
+      # helper methods below.
+      #
+      def self.perform_action(action, arg)
+        c = Curl::Easy.new("https://api.ziprecruiter.com/job-alerts/v1/#{action.to_s}")
+        c.http_auth_types = :basic
+        c.userpwd = "#{api_key}:"
+
+        case action
+        when :subscribe, :unsubscribe
+          path = File.expand_path(arg.to_s)
+          if !File.exists?(path)
+            raise "File \"#{path}\" does not exist."
+          end
+
+          c.multipart_form_post = true
+          c.http_post(Curl::PostField.file('content', path.to_s)) # http_post calls perform
+
+        when :status
+          c.url += "/#{arg.to_s}"
+          c.perform
+
+        else
+          raise "Unknown action \"#{action.to_s}\"."
+        end
+
+        c.body_str
+      end
+
+      ##
+      # A Subscribe action is used to upload a collection of job seekers to subscribe to our job alerts program.
+      #
+      def self.subscribe(path)
+        ZipRecruiter::JobAlerts::API.perform_action :subscribe, path
+      end
+
+      ##
+      # An Unsubscribe action is used to upload a collection of job seekers to unsubscribe from our job alerts program.
+      #
+      def self.unsubscribe(path)
+        ZipRecruiter::JobAlerts::API.perform_action :unsubscribe, path
+      end
+
+      ##
+      # A Status action returns the current status of a previously-submitted request.
+      #
+      def self.status(task_id)
+        ZipRecruiter::JobAlerts::API.perform_action :status, task_id
+      end
+    end
+  end
+end

data/lib/zip_recruiter/job_alerts/cli.rb

@@ -0,0 +1,38 @@
+require 'thor'
+require 'thor/group'
+require 'zip_recruiter/api'
+require 'zip_recruiter/job_alerts/api'
+
+module ZipRecruiter
+  module JobAlerts
+    class CLI < Thor
+      class_option :api_key, :aliases => "-k", :desc => "Specify your ZipRecruiter Job Alerts API key."
+
+      desc "subscribe [PATH]", "A Subscribe action is used to upload a collection of job seekers to subscribe to the ZipRecruiter job alerts program."
+      def subscribe(path)
+        ZipRecruiter::API.api_key = options[:api_key] unless options[:api_key].nil?
+        if File.exists?(path)
+          p ZipRecruiter::JobAlerts::API.subscribe(path)
+        else
+          puts "File \"#{path}\" does not exist."
+        end
+      end
+
+      desc "unsubscribe [PATH]", "An Unsubscribe action is used to upload a collection of job seekers to unsubscribe from the ZipRecruiter job alerts program."
+      def unsubscribe(path)
+        ZipRecruiter::API.api_key = options[:api_key] unless options[:api_key].nil?
+        if File.exists?(path)
+          p ZipRecruiter::JobAlerts::API.unsubscribe(path)
+        else
+          puts "File \"#{path}\" does not exist."
+        end
+      end
+
+      desc "status [TASK_ID]", "A Status action returns the current status of a previously-submitted request."
+      def status(task_id)
+        ZipRecruiter::API.api_key = options[:api_key] unless options[:api_key].nil?
+        p ZipRecruiter::JobAlerts::API.status(task_id)
+      end
+    end
+  end
+end

data/lib/zip_recruiter/version.rb

@@ -0,0 +1,3 @@
+module ZipRecruiter
+  VERSION = "1.0.1"
+end

data/spec/spec_helper.rb

@@ -0,0 +1,17 @@
+# This file was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# Require this file using `require "spec_helper"` to ensure that it is only
+# loaded once.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+RSpec.configure do |config|
+  config.treat_symbols_as_metadata_keys_with_true_values = true
+  config.run_all_when_everything_filtered = true
+  config.filter_run :focus
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = 'random'
+end

data/spec/zip_recruiter/job_alerts/api_spec.rb

@@ -0,0 +1,77 @@
+require 'spec_helper'
+require 'zip_recruiter/job_alerts'
+require 'zip_recruiter/job_alerts/api'
+
+describe ZipRecruiter::JobAlerts::API do
+  before :each do
+    ZipRecruiter::API.api_key = '' # might not need this?
+    @curl_easy = mock Curl::Easy
+    Curl::Easy.stub(:new).and_return(@curl_easy)
+    Curl::PostField.stub(:file)
+    @curl_easy.stub(:http_auth_types=)
+    @curl_easy.stub(:userpwd=)
+    @curl_easy.stub(:url).and_return("")
+    @curl_easy.stub(:url=)
+    @curl_easy.stub(:multipart_form_post=)
+    @curl_easy.stub(:http_post)
+    @curl_easy.stub(:perform)
+    @curl_easy.stub(:body_str)
+  end
+
+  describe "#perform_action" do
+    it "raises an exception when called with an unknown action" do
+      lambda { ZipRecruiter::JobAlerts::API.perform_action(:unknown_action, nil) }.should raise_error
+    end
+
+    it "works when called with subscribe and a good file path" do
+      File.stub(:exists?).and_return(true) # pretend the file exists
+      @curl_easy.should_receive(:http_post)
+      @curl_easy.should_receive(:body_str)
+      ZipRecruiter::JobAlerts::API.perform_action(:subscribe, '/path/to/good/file.csv')
+    end
+
+    it "raises an exception when called with subscribe and a bad file path" do
+      File.stub(:exists?).and_return(false) # pretend the file does not exist
+      lambda { ZipRecruiter::JobAlerts::API.perform_action(:subscribe, "/path/to/bad/file.csv") }.should raise_error
+    end
+
+    it "works when called with unsubscribe and a good file path" do
+      File.stub(:exists?).and_return(true) # pretend the file exists
+      @curl_easy.should_receive(:http_post)
+      @curl_easy.should_receive(:body_str)
+      ZipRecruiter::JobAlerts::API.perform_action(:unsubscribe, '/path/to/good/file.csv')
+    end
+
+    it "raises an exception when called with unsubscribe and a bad file path" do
+      File.stub(:exists?).and_return(false) # pretend the file does not exist
+      lambda { ZipRecruiter::JobAlerts::API.perform_action(:unsubscribe, "/path/to/bad/file.csv") }.should raise_error
+    end
+
+    it "works when called with status and a string argument" do
+      @curl_easy.should_receive(:perform)
+      @curl_easy.should_receive(:body_str)
+      ZipRecruiter::JobAlerts::API.perform_action(:status, "foobar")
+    end
+  end
+
+  describe "#subscribe" do
+    it "calls perform_action subscribe with the correct argument" do
+      ZipRecruiter::JobAlerts::API.should_receive(:perform_action).with(:subscribe, "the path")
+      ZipRecruiter::JobAlerts::API.subscribe("the path")
+    end
+  end
+
+  describe "#unsubscribe" do
+    it "calls perform_action unsubscribe with the correct argument" do
+      ZipRecruiter::JobAlerts::API.should_receive(:perform_action).with(:unsubscribe, "the path")
+      ZipRecruiter::JobAlerts::API.unsubscribe("the path")
+    end
+  end
+
+  describe "#status" do
+    it "calls perform_action status with the correct argument" do
+      ZipRecruiter::JobAlerts::API.should_receive(:perform_action).with(:status, "the task id")
+      ZipRecruiter::JobAlerts::API.status("the task id")
+    end
+  end
+end

data/spec/zip_recruiter/job_alerts/cli_spec.rb

@@ -0,0 +1,48 @@
+require 'stringio'
+require 'spec_helper'
+require 'zip_recruiter/job_alerts'
+require 'zip_recruiter/job_alerts/cli'
+
+describe ZipRecruiter::JobAlerts::CLI do
+  before :each do
+    $stdout = StringIO.new # redirect stdout
+    ZipRecruiter::API.api_key = '' # might not need this?
+    @jobalerts_cli = ZipRecruiter::JobAlerts::CLI.new
+    ZipRecruiter::JobAlerts::API.stub(:subscribe)
+    ZipRecruiter::JobAlerts::API.stub(:unsubscribe)
+    ZipRecruiter::JobAlerts::API.stub(:status)
+  end
+
+  describe "#subscribe" do
+    it "raises an exception when called with a bad file path" do
+      $stdout.should_receive(:puts).with("File \"/path/to/bad/file.csv\" does not exist.")
+      @jobalerts_cli.subscribe("/path/to/bad/file.csv")
+    end
+
+    it "calls the subscribe api method when given a good file path" do
+      File.stub(:exists?).and_return(true) # pretend the file exists
+      ZipRecruiter::JobAlerts::API.should_receive(:subscribe).with("/path/to/good/file.csv")
+      @jobalerts_cli.subscribe("/path/to/good/file.csv")
+    end
+  end
+
+  describe "#unsubscribe" do
+    it "raises an exception when called with a bad file path" do
+      $stdout.should_receive(:puts).with("File \"/path/to/bad/file.csv\" does not exist.")
+      @jobalerts_cli.unsubscribe("/path/to/bad/file.csv")
+    end
+
+    it "calls the unsubscribe api method when given a good file path" do
+      File.stub(:exists?).and_return(true) # pretend the file exists
+      ZipRecruiter::JobAlerts::API.should_receive(:unsubscribe).with("/path/to/good/file.csv")
+      @jobalerts_cli.unsubscribe("/path/to/good/file.csv")
+    end
+  end
+
+  describe "#status" do
+    it "calls the status api method" do
+      ZipRecruiter::JobAlerts::API.should_receive(:status).with("foobar")
+      @jobalerts_cli.status("foobar")
+    end
+  end
+end

data/zip_recruiter.gemspec

@@ -0,0 +1,23 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'zip_recruiter/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "zip_recruiter"
+  gem.version       = ZipRecruiter::VERSION
+  gem.authors       = ["Adam Dunson"]
+  gem.email         = ["adam@cloudspace.com"]
+  gem.description   = %q{Provides a ruby interface to the ZipRecruiter Job Alerts API.}
+  gem.summary       = %q{Ruby ZipRecruiter Job Alerts API interface}
+  gem.homepage      = "https://github.com/adamdunson/zip_recruiter/"
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+
+  gem.add_dependency "curb"
+  gem.add_dependency "thor"
+  gem.add_development_dependency "rspec"
+end

metadata

@@ -0,0 +1,115 @@
+--- !ruby/object:Gem::Specification
+name: zip_recruiter
+version: !ruby/object:Gem::Version
+  version: 1.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Adam Dunson
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-10-15 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: curb
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: thor
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Provides a ruby interface to the ZipRecruiter Job Alerts API.
+email:
+- adam@cloudspace.com
+executables:
+- ziprecruiter
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/ziprecruiter
+- lib/zip_recruiter.rb
+- lib/zip_recruiter/api.rb
+- lib/zip_recruiter/cli.rb
+- lib/zip_recruiter/job_alerts.rb
+- lib/zip_recruiter/job_alerts/api.rb
+- lib/zip_recruiter/job_alerts/cli.rb
+- lib/zip_recruiter/version.rb
+- spec/spec_helper.rb
+- spec/zip_recruiter/job_alerts/api_spec.rb
+- spec/zip_recruiter/job_alerts/cli_spec.rb
+- zip_recruiter.gemspec
+homepage: https://github.com/adamdunson/zip_recruiter/
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: Ruby ZipRecruiter Job Alerts API interface
+test_files:
+- spec/spec_helper.rb
+- spec/zip_recruiter/job_alerts/api_spec.rb
+- spec/zip_recruiter/job_alerts/cli_spec.rb