oracle_hcm 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 30217904bdaf7fe51c434bad5e420ff155c706d17dc24ff900bd3e99c7b52f3c
+  data.tar.gz: aa624f11420a5dd1bbc2c3ed476f340df630eeb5fa052a09c50a66a2166ae974
+SHA512:
+  metadata.gz: b66c7269e95b9e228ceac55ea66a01ea0deb72a7cb4260d3573542224f947f960fd74a39518fcb17383b795e66b1468ebc14d6138cc1db1906826fdd1a5e1c50
+  data.tar.gz: 7411fd20bbfc8b52386578b91709efbef07c7470ec94e29ab9c2cfab1d29d335a03991611571267e743205f6268558091ee722430c2b33b5ee08474398a2fc40

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status
+
+Gemfile.lock
+
+/bin/test

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,7 @@
+---
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.5.1
+before_install: gem install bundler -v 2.0.2

data/CHANGELOG.md

@@ -0,0 +1,3 @@
+# oracle_hcm changelog
+
+All notable changes to oracle_hcm will be documented in this file.

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 Paul Holden
+
+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,31 @@
+# Oracle HCM SDK
+
+This gem is a library for interacting with the Oracle HCM REST API.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'oracle_hcm'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install oracle_hcm
+
+## Usage
+
+Check back later.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/paulholden2/oracle_hcm.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "oracle_hcm"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/oracle_hcm/attachment.rb

@@ -0,0 +1,29 @@
+require "oracle_hcm/resource"
+
+module OracleHcm
+  # An Attachment is a child resource of a Document Record (or Document of
+  # Record), and stores upload file data and metadata.
+  class Attachment < Resource
+    property :attachment_document_id, key: "AttachmentDocumentId"
+    property :content_type, key: "UploadFileContentType"
+    property :content_size, key: "UploadFileContentLength"
+    property :title, key: "Title"
+
+    # Download the file via a readable IO object.
+    def download
+      io = StringIO.new
+      res = client.connection.get do |req|
+        req.url uri(rel: "enclosure")
+        req.options.on_data = Proc.new do |chunk, total_bytes|
+          io << chunk
+        end
+      end
+      if res.success?
+        io.rewind
+        io
+      else
+        nil
+      end
+    end
+  end
+end

data/lib/oracle_hcm/client.rb

@@ -0,0 +1,65 @@
+require "faraday"
+require "json"
+require "oracle_hcm/resource_list"
+require "oracle_hcm/worker"
+require "oracle_hcm/document_record"
+
+module OracleHcm
+  class Client
+    attr_reader :endpoint, :username, :password
+
+    def initialize(endpoint, username, password)
+      @endpoint = endpoint
+      @username = username
+      @password = password
+    end
+
+    # Sugar syntax for defining top-level resources
+    def self.resource(method, resource:, url: resource.resource_name)
+      define_method(method) do |offset: 0, limit: 20, q: []|
+        if !q.is_a?(Array)
+          q = [q]
+        end
+        res = connection.get do |req|
+          req.url url
+          req.params["offset"] = offset
+          req.params["limit"] = limit
+          if q.any?
+            req.params["q"] = q.join(";")
+          end
+        end
+        if res.success?
+          ResourceList.new(JSON.parse(res.body), offset, limit, method, resource, self)
+        else
+          nil
+        end
+      end
+    end
+
+    # Retrieve worker resources.
+    resource :workers, resource: Worker
+    # Retrieve document record resources.
+    resource :document_records, resource: DocumentRecord
+
+    # Retrieve a single worker resource by PersonId
+    def worker(id:)
+      workers(q: "PersonId=#{id}").items.first
+    end
+
+    # Retrieve a single document record resource by DocumentsOfRecordId
+    def document_record(id:)
+      document_records(q: "DocumentsOfRecordId=#{id}").items.first
+    end
+
+    def base_url
+      "#{endpoint}/hcmRestApi/resources/11.13.18.05"
+    end
+
+    # Get an authenticated Faraday connection using given credentials.
+    def connection
+      Faraday.new(url: base_url) do |conn|
+        conn.basic_auth(username, password)
+      end
+    end
+  end
+end

data/lib/oracle_hcm/document_record.rb

@@ -0,0 +1,19 @@
+require "oracle_hcm/resource"
+require "oracle_hcm/attachment"
+
+module OracleHcm
+  # A DocumentRecord is a resource that represents a record of document(s)
+  # of a given category for a Worker.
+  class DocumentRecord < Resource
+    property :document_record_id, key: "DocumentsOfRecordId"
+    property :category_code, key: "CategoryCode"
+    property :subcategory_code, key: "SubCategoryCode"
+    property :document_type, key: "DocumentType"
+    property :system_document_type, key: "SystemDocumentType"
+    child_resource :attachments, resource: Attachment
+
+    def canonical_id
+      document_record_id
+    end
+  end
+end

data/lib/oracle_hcm/name.rb

@@ -0,0 +1,11 @@
+require "oracle_hcm/resource"
+
+module OracleHcm
+  # A Name is a child resource of a Worker that stores various data about a
+  # Worker's name(s).
+  class Name < Resource
+    property :first_name, key: "FirstName"
+    property :last_name, key: "LastName"
+    property :previous_last_name, key: "PreviousLastName"
+  end
+end

data/lib/oracle_hcm/national_identifier.rb

@@ -0,0 +1,11 @@
+require "oracle_hcm/resource"
+
+module OracleHcm
+  # A NationalIdentifier is a child resource of a Worker that stores various
+  # uniquely identifying information about a Worker, such as their SSN.
+  class NationalIdentifier < Resource
+    property :national_identifier_type, key: "NationalIdentifierType"
+    property :national_identifier_number, key: "NationalIdentifierNumber"
+    property :primary_flag, key: "PrimaryFlag"
+  end
+end

data/lib/oracle_hcm/resource.rb

@@ -0,0 +1,97 @@
+module OracleHcm
+  # Base class for all resources in Oracle HCM. Provides some sugar syntax
+  # and shared methods.
+  class Resource
+    attr_reader :data, :client, :parent
+
+    def initialize(data, client, parent = nil)
+      @data = data
+      @client = client
+      @parent = parent
+      @cache = {}
+    end
+
+    # Sugar syntax for defining methods that return data at given keys in
+    # the resource JSON. Properties are not a 1:1 match with data in the
+    # object JSON. They can be wrappers for sending requests to related
+    # resources such as names or addresses, although those are better defined
+    # as cached properties.
+    def self.property(name, key: nil, &block)
+      define_method(name) {
+        if block_given?
+          yield
+        else
+          data.fetch(key)
+        end
+      }
+    end
+
+    # Sugar syntax for defining properties that are cached to avoid making
+    # multiple requests for data that is not expected to change during
+    # execution, such as employee names or SSNs. Also defines a bang method
+    # that will skip and overwrite the cache.
+    def self.cached_property(name, &block)
+      bang = :"#{name.to_s}!"
+      define_method(bang) {
+        instance_variable_get(:@cache)[name] = instance_eval(&block)
+      }
+      define_method(name) {
+        @cache[name] || self.send(bang)
+      }
+    end
+
+    # Sugar syntax for defining child resource retrieval methods
+    def self.child_resource(method, resource:)
+      define_method(method) do |offset: 0, limit: 20, q: []|
+        # Generate the URL for the request
+        url = "#{resource_name}/#{canonical_id}/child/#{resource.resource_name}"
+        if !q.is_a?(Array)
+          q = [q]
+        end
+        res = client.connection.get do |req|
+          req.url url
+          req.params["offset"] = offset
+          req.params["limit"] = limit
+          if q.any?
+            req.params["q"] = q.join(";")
+          end
+        end
+        if res.success?
+          ResourceList.new(JSON.parse(res.body), offset, limit, method, resource, client, self)
+        else
+          nil
+        end
+      end
+    end
+
+    def self.resource_name
+      name = self.to_s.split("::").last
+      "#{name[0].downcase}#{name[1..-1]}s"
+    end
+
+    def resource_name
+      self.class.resource_name
+    end
+
+    # Retrieve a link by its relationship. By default, returns the self link.
+    def link(rel: "self")
+      data.fetch("links").select { |link|
+        link.fetch("rel") == rel
+      }.first
+    end
+
+    # Although resources have unique identifiers, the API does not use these
+    # in the URL to retrieve some resources. Instead, a longer identifier
+    # string is used. This identifier is only displayed as part of the self
+    # link for the resource.
+    def canonical_id
+      # Extract resource identifier from self link
+      m = link.fetch("href").match(/\/([0-9A-F]+)\z/)
+      m[1]
+    end
+
+    def uri(rel: "self")
+      link(rel: rel).fetch("href").gsub(client.base_url, "")
+    end
+  end
+end

data/lib/oracle_hcm/resource_list.rb

@@ -0,0 +1,27 @@
+require "oracle_hcm/resource"
+
+module OracleHcm
+  # A ResourceList is a helper object that makes it easy to poll through
+  # paginated resources.
+  class ResourceList < Resource
+    attr_reader :limit, :offset, :method, :resource, :client, :parent
+
+    def initialize(data, offset, limit, method, resource, client, parent = nil)
+      super(data, client)
+      @limit = limit
+      @offset = offset
+      @method = method
+      @resource = resource
+    end
+
+    def next
+      client.send(method, limit: limit, offset: offset + limit)
+    end
+
+    def items
+      @data.fetch("items").map { |item|
+        resource.new(item, client, parent)
+      }
+    end
+  end
+end

data/lib/oracle_hcm/version.rb

@@ -0,0 +1,3 @@
+module OracleHcm
+  VERSION = "0.1.1"
+end

data/lib/oracle_hcm/worker.rb

@@ -0,0 +1,20 @@
+require "oracle_hcm/resource"
+require "oracle_hcm/name"
+require "oracle_hcm/national_identifier"
+require "oracle_hcm/document_record"
+
+module OracleHcm
+  # A Worker is a resources that represents an employee within the system.
+  class Worker < Resource
+    child_resource :names, resource: Name
+    child_resource :national_identifiers, resource: NationalIdentifier
+    property :person_id, key: "PersonId"
+    property :person_number, key: "PersonNumber"
+    cached_property :first_name do names.items.first.first_name; end
+    cached_property :last_name do names.items.first.last_name; end
+
+    def ssns
+      national_identifiers q: "NationalIdentifierType=SSN"
+    end
+  end
+end

data/lib/oracle_hcm.rb

@@ -0,0 +1,7 @@
+require "oracle_hcm/version"
+require "oracle_hcm/client"
+
+module OracleHcm
+  class Error < StandardError; end
+  # Your code goes here...
+end

data/oracle_hcm.gemspec

@@ -0,0 +1,35 @@
+lib = File.expand_path("lib", __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "oracle_hcm/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "oracle_hcm"
+  spec.version       = OracleHcm::VERSION
+  spec.authors       = ["Paul Holden"]
+  spec.email         = ["paul@holdensoftware.com"]
+
+  spec.summary       = %q{A library for interacting with the Oracle HCM REST API.}
+  spec.homepage      = "https://github.com/paulholden2/oracle_hcm"
+  spec.license       = "MIT"
+
+  spec.metadata["allowed_push_host"] = "https://rubygems.org"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/paulholden2/oracle_hcm"
+  spec.metadata["changelog_uri"] = "https://github.com/paulholden2/oracle_hcm/blog/master/CHANGELOG.md"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "faraday", "~> 1.0"
+
+  spec.add_development_dependency "bundler", "~> 2.0"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

data/pkg/.gitignore

@@ -0,0 +1 @@
+*.gem

metadata

@@ -0,0 +1,125 @@
+--- !ruby/object:Gem::Specification
+name: oracle_hcm
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- Paul Holden
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2020-07-27 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description:
+email:
+- paul@holdensoftware.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CHANGELOG.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/oracle_hcm.rb
+- lib/oracle_hcm/attachment.rb
+- lib/oracle_hcm/client.rb
+- lib/oracle_hcm/document_record.rb
+- lib/oracle_hcm/name.rb
+- lib/oracle_hcm/national_identifier.rb
+- lib/oracle_hcm/resource.rb
+- lib/oracle_hcm/resource_list.rb
+- lib/oracle_hcm/version.rb
+- lib/oracle_hcm/worker.rb
+- oracle_hcm.gemspec
+- pkg/.gitignore
+homepage: https://github.com/paulholden2/oracle_hcm
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://github.com/paulholden2/oracle_hcm
+  source_code_uri: https://github.com/paulholden2/oracle_hcm
+  changelog_uri: https://github.com/paulholden2/oracle_hcm/blog/master/CHANGELOG.md
+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: []
+rubygems_version: 3.0.8
+signing_key:
+specification_version: 4
+summary: A library for interacting with the Oracle HCM REST API.
+test_files: []