spear-cb-api 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: c347867ceceb0398580e288d134eb2aa2b3e9c4a
+  data.tar.gz: 7d488d3e2419fb71060740d8a5f8b6cf25e94942
+SHA512:
+  metadata.gz: 5350b889086c8cbadea37283ac9507dfbc6c43e1d965246a53e4ea0bb03c08f51447c296b22556161a7227a2ba1cf112fdc0cb1534a0c489908c8cf102d452d4
+  data.tar.gz: 978e149c92640f48eb988ff4a09f8ab072aa6f920c17bc5f8fe9c11faef7314c0861340315db137a07e5f8b79bad0c63aec645c49217ab77f701a8352715edbc

data/.gitignore

@@ -0,0 +1,22 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/.rspec

@@ -0,0 +1,4 @@
+--color
+--format documentation
+--require spec_helper
+--seed 123456

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 CBluowei
+
+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,29 @@
+# Spear Cb Api
+
+TODO: Write a gem description
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'spear-cb-api'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install spear-cb-api
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/spear-cb-api/fork )
+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 a new Pull Request

data/Rakefile

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

data/lib/spear.rb

@@ -0,0 +1,17 @@
+# encoding: utf-8
+
+require "spear/version"
+
+module Spear
+  autoload :AsyncJob, 'spear/async_job'
+  autoload :Client, 'spear/client'
+  autoload :Request, 'spear/request'
+
+  # exception
+  autoload :InvalidClientOptionsException, 'spear/exceptions'
+
+  module Resource
+    autoload :User, 'spear/resource/user'
+    autoload :Resume, 'spear/resource/resume'
+  end
+end

data/lib/spear/async_job.rb

@@ -0,0 +1,23 @@
+# encoding: utf-8
+
+module Spear
+  class AsyncJob
+    include SuckerPunch::Job
+
+    def perform(options={})
+      # TODO: save the error to log
+      HTTParty.post(
+        %q{http://ciws.hilotus.com/api/v1/api-info},
+        :body => {
+          :project => options[:project],
+          :url => options[:url],
+          :method => options[:method],
+          :request => options[:request],
+          :response => options[:response],
+          :duration => options[:duration]
+        }.to_json,
+        :options => {:headers => {'Content-Type' => 'application/json'}}
+      ) rescue options
+    end
+  end
+end

data/lib/spear/client.rb

@@ -0,0 +1,58 @@
+# encoding: utf-8
+
+module Spear
+  class Client
+    include Spear::Resource::User
+    include Spear::Resource::Resume
+
+    attr_reader :options, :request
+
+    def initialize(options={})
+      raise Spear::InvalidClientOptionsException.new('DeveloperKey is missing!') if options[:dev_key].nil?
+      raise Spear::InvalidClientOptionsException.new('ProjectName is missing!') if options[:project].nil?
+
+      @options = options
+      @request = generate_request
+    end
+
+    def test?
+      @options[:use_test] || false
+    end
+
+    # use https or http
+    def ssh?
+      @options[:use_ssh] || true
+    end
+
+    def hostname
+      @options[:hostname] || 'api.careerbuilder.com'
+    end
+
+    def port
+      @options[:port] || 443
+    end
+
+    def version
+      @options[:version] || "v2"
+    end
+
+    def dev_key
+      @options[:dev_key]
+    end
+
+    # need save api info
+    def save_api?
+      @options[:use_saving_api] || false
+    end
+
+    def project
+      @options[:project]
+    end
+
+    private
+      def generate_request(options={})
+        options = {:client => self}.merge(options)
+        return Spear::Request.new(options)
+      end
+  end
+end

data/lib/spear/exceptions.rb

@@ -0,0 +1,3 @@
+module Spear
+  class InvalidClientOptionsException < Exception; end
+end

data/lib/spear/request.rb

@@ -0,0 +1,76 @@
+module Spear
+  class Request
+    attr_reader :client, :resource
+
+    def initialize(options={})
+      @client = options[:client]
+      @resource = resource
+      @async_job = Spear::AsyncJob.new
+    end
+
+    # TODO: custom reqeust headers support.
+    # payload: {:body => {}, :query => {}}
+    def execute(http_method, endpoint, payload={})
+      start_time = Time.now;
+      url = @resource + endpoint;
+
+      case http_method
+      when :get
+        req = splice(payload)
+        resp = HTTParty.get(url, req)
+      when :post
+        req = {:body => to_xml(payload)}
+        resp = HTTParty.post(url, req)
+      when :upload_file
+        req = splice(payload)
+        req[:body] = "file base64 content..."
+        resp = HTTParty.post(url, splice(payload))
+      when :parse_file
+        req = {:body => payload}
+        req[:body][:FileBytes] = nil
+        resp = HTTParty.post(url, :body => to_xml(payload))
+      else
+        resp = {"Errors" => {"Error" => "%q{#{http_method} http method is not support.}"}}
+      end
+
+      if @client.save_api?
+        options = {
+          project: @client.project,
+          request: req,
+          response: resp.to_h,
+          method: http_method.to_s,
+          url: url,
+          duration: ((Time.now - start_time).to_f * 1000.0).to_i
+        }
+        @async_job.async.perform(options)
+      end
+
+      resp
+    end
+
+    private
+      def resource
+        uri = URI("")
+        uri.scheme = @client.ssh? ? 'https' : 'http'
+        uri.host = @client.hostname
+        uri.port = @client.port
+        uri.path = "/#{@client.version}"
+        uri.to_s
+      end
+
+      # parse payload to xml format
+      def to_xml(payload)
+        payload[:DeveloperKey] = @client.dev_key
+        payload[:Test] = @client.test?
+        payload = payload.to_xml(root: 'Request', skip_instruct: true, skip_types: true)
+      end
+
+      # splice payload {:body => {}, :query => {}} with DeveloperKey and Test
+      def splice(payload)
+        payload[:query][:DeveloperKey] = @client.dev_key
+        payload[:query][:Test] = @client.test?
+        payload
+      end
+
+  end
+end

data/lib/spear/resource/resume.rb

@@ -0,0 +1,75 @@
+# encoding: utf-8
+
+module Spear
+  module Resource
+    module Resume
+      # file: kind of ActionDispatch::Http::UploadedFile
+      def parse_file(file)
+        unless (file.kind_of? ActionDispatch::Http::UploadedFile) || (file.kind_of? Rack::Test::UploadedFile)
+          return {"Errors" => {"Error" => "%q{Expecting type of ActionDispatch::Http::UploadedFile or Rack::Test::UploadedFile, but got #{file.class}.}"}}
+        end
+
+        file.rewind
+        @request.execute(:parse_file, "/resume/parse", {:FileName => file.original_filename,
+          :FileBytes => Base64.encode64(file.read)})
+      end
+
+      # Required column value
+      # <ShowContactInfo>true</ShowContactInfo>
+      # <Title>asasdasdasd</Title>
+      # <ResumeText>albee009@gmail.com JobsCentral999</ResumeText>
+      # <Visibility>true</Visibility>
+      # <CanRelocateNationally>false</CanRelocateNationally>
+      # <CanRelocateInternationally>false</CanRelocateInternationally>
+      # <TotalYearsExperience>0</TotalYearsExperience>
+      # <HostSite>T3</HostSite>
+      # <DesiredJobTypes>ETFE</DesiredJobTypes>
+      # <CompanyExperiences/>
+      # <Educations/>
+      # <Languages/>
+      # <CustomValues/>
+      def create_resume(data={})
+        @request.execute(:post, "/resume/create", data)
+      end
+
+      def upload_file(file, resume_external_id, user_external_id)
+        unless (file.kind_of? ActionDispatch::Http::UploadedFile) || (file.kind_of? Rack::Test::UploadedFile)
+          return {"Errors" => {"Error" => "%q{Expecting type of ActionDispatch::Http::UploadedFile or Rack::Test::UploadedFile, but got #{file.class}.}"}}
+        end
+
+        if user_external_id.blank? or resume_external_id.blank?
+          return {"Errors" => {"Error" => "%q{User external ID and resume external ID is required.}"}}
+        end
+
+        file.rewind
+        @request.execute(:upload_file, "/resume/upload", {
+          :body => Base64.encode64(file.read),
+          :query => {
+            :FileName => file.original_filename,
+            :ExternalID => resume_external_id,
+            :ExternalUserID => user_external_id
+          }
+        })
+      end
+
+      # list all of my resumes
+      def own_all(user_external_id, host_site)
+        if user_external_id.blank? or host_site.blank?
+          return {"Errors" => {"Error" => "%q{User external ID and host site is required.}"}}
+        end
+
+        @request.execute(:get, "/resume/ownall", {
+          :query => {:ExternalUserID => user_external_id, :HostSite => host_site}})
+      end
+
+      def retrieve_resume(resume_external_id, user_external_id)
+        if user_external_id.blank? or resume_external_id.blank?
+          return {"Errors" => {"Error" => "%q{User external ID and host site is required.}"}}
+        end
+
+        @request.execute(:get, "/resume/retrieve", {
+          :query => {:ExternalUserID => user_external_id, :ExternalID => resume_external_id}})
+      end
+    end
+  end
+end

data/lib/spear/resource/user.rb

@@ -0,0 +1,23 @@
+# encoding: utf-8
+
+module Spear
+  module Resource
+    module User
+      def check_existing(email, password='')
+        if password.blank?
+          @request.execute(:post, "/user/checkexisting", {:Email => email})
+        else
+          @request.execute(:post, "/user/checkexisting", {:Email => email, :Password => password})
+        end
+      end
+
+      def create_user(data={})
+        @request.execute(:post, "/user/create", data)
+      end
+
+      def retrieve_user(user_external_id, password)
+        @request.execute(:post, "/user/retrieve", {:ExternalID => user_external_id, :Password => password})
+      end
+    end
+  end
+end

data/lib/spear/version.rb

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

data/spear-cb-api.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'spear/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "spear-cb-api"
+  spec.version       = Spear::VERSION
+  spec.authors       = ["CBluowei"]
+  spec.email         = ["wei.luo@careerbuilder.com"]
+  spec.summary       = %q{Cb api wrapper}
+  spec.description   = %q{This gem include api wrapper, response structure and dummy data.}
+  spec.homepage      = "https://github.com/hilotus/spear-cb-api"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "sucker_punch", "~> 1.0"
+  spec.add_development_dependency "rspec", "~> 3.2", ">= 3.2.0"
+
+  spec.add_development_dependency "bundler", "~> 1.6"
+  spec.add_development_dependency "rake", "~> 10.4"
+end

data/spec/client_spec.rb

@@ -0,0 +1,5 @@
+describe Spear::Client do
+  it "check user existing" do
+
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,70 @@
+require 'bundler/setup'
+Bundler.setup
+
+require 'spear' # and any other gems you need
+
+RSpec.configure do |config|
+  # config.include Capybara::DSL,:type=>:request
+  # The settings below are suggested to provide a good initial experience
+  # with RSpec, but feel free to customize to your heart's content.
+  #=begin
+  # These two settings work together to allow you to limit a spec run
+  # to individual examples or groups you care about by tagging them with
+  # `:focus` metadata. When nothing is tagged with `:focus`, all examples
+  # get run.
+  # config.filter_run :focus
+  # config.run_all_when_everything_filtered = true
+
+  # Many RSpec users commonly either run the entire suite or an individual
+  # file, and it's useful to allow more verbose output when running an
+  # individual spec file.
+  # if config.files_to_run.one?
+  # Use the documentation formatter for detailed output,
+  # unless a formatter has already been configured
+  # (e.g. via a command-line flag).
+  # config.default_formatter = 'doc'
+  # end
+
+  # Print the 10 slowest examples and example groups at the
+  # end of the spec run, to help surface which specs are running
+  # particularly slow.
+  config.profile_examples = 10
+
+  # 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
+
+  # Seed global randomization in this process using the `--seed` CLI option.
+  # Setting this allows you to use `--seed` to deterministically reproduce
+  # test failures related to randomization by passing the same `--seed` value
+  # as the one that triggered the failure.
+  Kernel.srand config.seed
+
+  # rspec-expectations config goes here. You can use an alternate
+  # assertion/expectation library such as wrong or the stdlib/minitest
+  # assertions if you prefer.
+  config.expect_with :rspec do |expectations|
+    # Enable only the newer, non-monkey-patching expect syntax.
+    # For more details, see:
+    #   - http://myronmars.to/n/dev-blog/2012/06/rspecs-new-expectation-syntax
+    expectations.syntax = :expect
+
+    expectations.include_chain_clauses_in_custom_matcher_descriptions = true
+  end
+
+  # rspec-mocks config goes here. You can use an alternate test double
+  # library (such as bogus or mocha) by changing the `mock_with` option here.
+  config.mock_with :rspec do |mocks|
+    # Enable only the newer, non-monkey-patching expect syntax.
+    # For more details, see:
+    #   - http://teaisaweso.me/blog/2013/05/27/rspecs-new-message-expectation-syntax/
+    mocks.syntax = :expect
+
+    # Prevents you from mocking or stubbing a method that does not exist on
+    # a real object. This is generally recommended.
+    mocks.verify_partial_doubles = true
+  end
+  #=end
+end

metadata

@@ -0,0 +1,125 @@
+--- !ruby/object:Gem::Specification
+name: spear-cb-api
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- CBluowei
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-02-13 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: sucker_punch
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.2.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.2.0
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.4'
+description: This gem include api wrapper, response structure and dummy data.
+email:
+- wei.luo@careerbuilder.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/spear.rb
+- lib/spear/async_job.rb
+- lib/spear/client.rb
+- lib/spear/exceptions.rb
+- lib/spear/request.rb
+- lib/spear/resource/resume.rb
+- lib/spear/resource/user.rb
+- lib/spear/version.rb
+- spear-cb-api.gemspec
+- spec/client_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/hilotus/spear-cb-api
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: Cb api wrapper
+test_files:
+- spec/client_spec.rb
+- spec/spec_helper.rb