findwork_api 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 297def97752fe43d7998b2e9d1c3ab294fbb4f16a11263368b2f86075f022fab
+  data.tar.gz: d7a7034318c7beb0b5e976301598bf4e04e831cb33e9b47825e344f721e00848
+SHA512:
+  metadata.gz: 8c8a41f27b1879a3a0e15ae8a047d48ac9c19729d8ddbb4a79f80b5139b12ffd7253a4cbb7c4a22756bea13ffcc33195e1b4b99ad91064feaa166833a7f21524
+  data.tar.gz: 34baa252b9588ff9e4a5e5c22a9309ed048b4f6a6238e6357a019b6f510feb74670e2dbed7ebf2e98222c9b5918193fb9df582e46b6016beb2ab1199eaa9bf9f

data/CHANGELOG.md

@@ -0,0 +1 @@
+# Changelog

data/README.md

@@ -0,0 +1,39 @@
+# FindworkApi
+
+TODO: Delete this and the text below, and describe your gem
+
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/findwork_api`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+## Installation
+
+TODO: Replace `UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG` with your gem name right after releasing it to RubyGems.org. Please do not do it earlier due to security reasons. Alternatively, replace this section with instructions to install your gem from git if you don't plan to release to RubyGems.org.
+
+Install the gem and add to the application's Gemfile by executing:
+
+```bash
+bundle add UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG
+```
+
+If bundler is not being used to manage dependencies, install the gem by executing:
+
+```bash
+gem install UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG
+```
+
+## Usage
+
+```ruby
+client = FindworkApi::Client.new(api_key: ENV["FINDWORK_API_KEY"])
+jobs = client.jobs.list
+jobs.first.name
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/findwork_api.

data/Rakefile

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+task default: %i[]
+
+require "rake/testtask"
+
+Rake::TestTask.new do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList['test/**/*_test.rb']
+  t.verbose = true
+end
+
+task default: :test

data/lib/findwork_api/client.rb

@@ -0,0 +1,28 @@
+require "faraday"
+
+module FindworkApi
+  class Client
+    BASE_URL = "https://findwork.dev/api/"
+
+    attr_reader :api_key, :adapter
+
+    def initialize(api_key:, adapter: Faraday.default_adapter, stubs: nil)
+      @api_key = api_key
+      @adapter = adapter
+      @stubs = stubs
+    end
+
+    def connection
+      @connection ||= Faraday.new do |conn|
+        conn.url_prefix = BASE_URL
+        conn.request :json
+        conn.response :json, content_type: "application/json"
+        conn.adapter adapter, @stubs
+      end
+    end
+
+    def jobs
+      JobsResource.new(self)
+    end
+  end
+end

data/lib/findwork_api/collection.rb

@@ -0,0 +1,24 @@
+module FindworkApi
+  class Collection
+    attr_reader :count, :next_page, :previous_page, :data
+
+    def self.from_response(response, key:, type:)
+      body = response.body
+      # Nested values can be appended as additional arguments to dig
+      new(
+        count: body.dig("count"),
+        next_page: body.dig("next"),
+        previous_page: body.dig("previous"),
+        data: body[key].map { |attrs| type.new(attrs) }
+      )
+    end
+
+    def initialize(count:, next_page:, previous_page:, data:)
+      @count = count
+      @next_page = next_page.nil? ? nil : next_page
+      @previous_page = previous_page.nil? ? nil : previous_page
+      @data = data
+    end
+  end
+end
+

data/lib/findwork_api/error.rb

@@ -0,0 +1,3 @@
+module FindworkApi
+  class Error < StandardError; end
+end

data/lib/findwork_api/object.rb

@@ -0,0 +1,18 @@
+require "ostruct"
+
+module FindworkApi
+  class Object
+    def initialize(attributes)
+      @attributes = OpenStruct.new(attributes)
+    end
+
+    def method_missing(method, *args, &block)
+      attribute = @attributes.send(method, *args, &block)
+      attribute.is_a?(Hash) ? Object.new(attribute) : attribute
+    end
+
+    def respond_to_missing?(method, include_private = false)
+      true
+    end
+  end
+end

data/lib/findwork_api/objects/job.rb

@@ -0,0 +1,4 @@
+module FindworkApi
+  class Job < Object
+  end
+end

data/lib/findwork_api/resource.rb

@@ -0,0 +1,40 @@
+module FindworkApi
+  class Resource
+    attr_reader :client
+
+    def initialize(client)
+      @client = client
+    end
+
+    def get_request(url, params: {}, headers: {})
+      handle_response(client.connection.get(url, params, default_headers.merge(headers)))
+    end
+
+    def default_headers
+      { Authorization: "Token #{client.api_key}" }
+    end
+
+    def handle_response(response)
+      message = (response.body || {})["error"]
+
+      case response.status
+      when 400
+        raise Error, message
+      when 401
+        raise Error, message
+      when 403
+        raise Error, message
+      when 404
+        raise Error, message
+      when 422
+        raise Error, message
+      when 429
+        raise Error, message
+      when 500
+        raise Error, message
+      end
+
+      response
+    end
+  end
+end

data/lib/findwork_api/resources/jobs.rb

@@ -0,0 +1,22 @@
+module FindworkApi
+  class JobsResource < Resource
+    def list(search: nil, source: nil, location: nil, remote: nil, employees: nil, employment_type: nil, order_by: nil)
+      # TODO: Add pagination (in Collection)
+      Collection.from_response(get_request("jobs/",
+                                            params: {
+                                              search: search,
+                                              source: source,
+                                              location: location,
+                                              remote: remote,
+                                              company_num_employees: employees,
+                                              employment_type: employment_type,
+                                              order_by: order_by
+                                            }.compact
+                                          ), key: "results", type: Job)
+    end
+
+    def find(id)
+      Job.new get_request("jobs/#{id}", params: params)
+    end
+  end
+end

data/lib/findwork_api/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module FindworkApi
+  VERSION = "0.1.0"
+end

data/lib/findwork_api.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+require_relative "findwork_api/version"
+
+module FindworkApi
+  autoload :Client, "findwork_api/client"
+  autoload :Collection, "findwork_api/collection"
+  autoload :Error, "findwork_api/error"
+  autoload :Object, "findwork_api/object"
+  autoload :Resource, "findwork_api/resource"
+
+  autoload :Job, "findwork_api/objects/job"
+
+  autoload :JobsResource, "findwork_api/resources/jobs"
+end

data/sig/findwork_api.rbs

@@ -0,0 +1,4 @@
+module FindworkApi
+  VERSION: String
+  # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+end

metadata

@@ -0,0 +1,97 @@
+--- !ruby/object:Gem::Specification
+name: findwork_api
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Ian Johnson
+bindir: exe
+cert_chain: []
+date: 1980-01-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.13'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.13'
+- !ruby/object:Gem::Dependency
+  name: ostruct
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+description: A client for interacting with the Findwork API
+email:
+- tacoda@hey.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- README.md
+- Rakefile
+- lib/findwork_api.rb
+- lib/findwork_api/client.rb
+- lib/findwork_api/collection.rb
+- lib/findwork_api/error.rb
+- lib/findwork_api/object.rb
+- lib/findwork_api/objects/job.rb
+- lib/findwork_api/resource.rb
+- lib/findwork_api/resources/jobs.rb
+- lib/findwork_api/version.rb
+- sig/findwork_api.rbs
+homepage: https://github.com/tacoda/findwork_api
+licenses: []
+metadata:
+  homepage_uri: https://github.com/tacoda/findwork_api
+  source_code_uri: https://github.com/tacoda/findwork_api
+  changelog_uri: https://github.com/tacoda/findwork_api/blob/main/CHANGELOG.md
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.1.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.6.9
+specification_version: 4
+summary: A gem for the Findwork API
+test_files: []