smarthr 0.0.1

data/lib/smarthr/client/job_title_methods.rb

@@ -0,0 +1,80 @@
+module SmartHR::Client::JobTitleMethods
+  # Delete the job title
+  #
+  # @see https://developer.smarthr.jp/api/index.html#!/%E5%BD%B9%E8%81%B7/deleteV1JobTitlesId
+  #
+  # @param id [String]
+  #
+  # @yield [response_body, response_header] if block was given, return response body and response header through block arguments
+  # @yieldparam response_body [Hashie::Mash] response body
+  # @yieldparam response_header [Hash<String, String>] response header (e.g. X-Rate-Limit-Limit, X-Rate-Limit-Reset, X-Rate-Limit-Remaining)
+  def destroy_job_title(id:, &block)
+    delete("/job_titles/#{id}", &block)
+  end
+
+  # Get the job title
+  #
+  # @see https://developer.smarthr.jp/api/index.html#!/%E5%BD%B9%E8%81%B7/getV1JobTitlesId
+  #
+  # @param id [String]
+  #
+  # @yield [response_body, response_header] if block was given, return response body and response header through block arguments
+  # @yieldparam response_body [Hashie::Mash] response body
+  # @yieldparam response_header [Hash<String, String>] response header (e.g. X-Rate-Limit-Limit, X-Rate-Limit-Reset, X-Rate-Limit-Remaining)
+  #
+  # @return [Hashie::Mash]
+  def find_job_title(id:, &block)
+    get("/job_titles/#{id}", &block)
+  end
+
+  # Change the data of the specified job title
+  #
+  # @see https://developer.smarthr.jp/api/index.html#!/%E5%BD%B9%E8%81%B7/patchV1JobTitlesId
+  #
+  # @param id   [String]
+  # @param body [Hash]
+  #
+  # @yield [response_body, response_header] if block was given, return response body and response header through block arguments
+  # @yieldparam response_body [Hashie::Mash] response body
+  # @yieldparam response_header [Hash<String, String>] response header (e.g. X-Rate-Limit-Limit, X-Rate-Limit-Reset, X-Rate-Limit-Remaining)
+  #
+  # @return [Hashie::Mash]
+  def update_job_title(id:, body:, &block)
+    patch("/job_titles/#{id}", body, &block)
+  end
+
+  # Get the list of job titles
+  #
+  # @see https://developer.smarthr.jp/api/index.html#!/%E5%BD%B9%E8%81%B7/getV1JobTitles
+  #
+  # @param page     [Integer]
+  # @param per_page [Integer]
+  #
+  # @yield [response_body, response_header] if block was given, return response body and response header through block arguments
+  # @yieldparam response_body [Array<Hashie::Mash>] response body
+  # @yieldparam response_header [Hash<String, String>] response header (e.g. X-Rate-Limit-Limit, X-Rate-Limit-Reset, X-Rate-Limit-Remaining)
+  #
+  # @return [Array<Hashie::Mash>]
+  def get_job_titles(page: 1, per_page: 10, &block)
+    get("/job_titles",
+      page: page,
+      per_page: per_page,
+      &block
+    )
+  end
+
+  # Create a new job title
+  #
+  # @see https://developer.smarthr.jp/api/index.html#!/%E5%BD%B9%E8%81%B7/postV1JobTitles
+  #
+  # @param body [Hash]
+  #
+  # @yield [response_body, response_header] if block was given, return response body and response header through block arguments
+  # @yieldparam response_body [Hashie::Mash] response body
+  # @yieldparam response_header [Hash<String, String>] response header (e.g. X-Rate-Limit-Limit, X-Rate-Limit-Reset, X-Rate-Limit-Remaining)
+  #
+  # @return [Hashie::Mash]
+  def create_job_title(body:, &block)
+    post("/job_titles", body, &block)
+  end
+end

data/lib/smarthr/client/mail_format_methods.rb

@@ -0,0 +1,39 @@
+module SmartHR::Client::MailFormatMethods
+  # Get the mail format
+  #
+  # @see https://developer.smarthr.jp/api/index.html#!/%E3%83%A1%E3%83%BC%E3%83%AB%E3%83%95%E3%82%A9%E3%83%BC%E3%83%9E%E3%83%83%E3%83%88/getV1MailFormatsId
+  #
+  # @param id                     [String]
+  # @param embed_crew_input_forms [Boolean] Whether or not to embed crew input forms
+  #
+  # @yield [response_body, response_header] if block was given, return response body and response header through block arguments
+  # @yieldparam response_body [Hashie::Mash] response body
+  # @yieldparam response_header [Hash<String, String>] response header (e.g. X-Rate-Limit-Limit, X-Rate-Limit-Reset, X-Rate-Limit-Remaining)
+  #
+  # @return [Hashie::Mash]
+  def find_mail_format(id:, embed_crew_input_forms: false, &block)
+    get("/mail_formats/#{id}", embed: embed_crew_input_forms ? 'crew_input_forms' : nil, &block)
+  end
+
+  # Get the list of mail formats
+  #
+  # @see https://developer.smarthr.jp/api/index.html#!/%E3%83%A1%E3%83%BC%E3%83%AB%E3%83%95%E3%82%A9%E3%83%BC%E3%83%9E%E3%83%83%E3%83%88/getV1MailFormats
+  #
+  # @param page                   [Integer]
+  # @param per_page               [Integer]
+  # @param embed_crew_input_forms [Boolean] Whether or not to embed crew input forms
+  #
+  # @yield [response_body, response_header] if block was given, return response body and response header through block arguments
+  # @yieldparam response_body [Array<Hashie::Mash>] response body
+  # @yieldparam response_header [Hash<String, String>] response header (e.g. X-Rate-Limit-Limit, X-Rate-Limit-Reset, X-Rate-Limit-Remaining)
+  #
+  # @return [Array<Hashie::Mash>]
+  def get_mail_formats(page: 1, per_page: 10, embed_crew_input_forms: false, &block)
+    get("/mail_formats",
+      page: page,
+      per_page: per_page,
+      embed: embed_crew_input_forms ? 'crew_input_forms' : nil,
+      &block
+    )
+  end
+end

data/lib/smarthr/client/payment_period_methods.rb

@@ -0,0 +1,36 @@
+module SmartHR::Client::PaymentPeriodMethods
+  # Get the payment period
+  #
+  # @see https://developer.smarthr.jp/api/index.html#!/%E7%B5%A6%E4%B8%8E%E6%94%AF%E7%B5%A6%E5%BD%A2%E6%85%8B/getV1PaymentPeriodsId
+  #
+  # @param id [String]
+  #
+  # @yield [response_body, response_header] if block was given, return response body and response header through block arguments
+  # @yieldparam response_body [Hashie::Mash] response body
+  # @yieldparam response_header [Hash<String, String>] response header (e.g. X-Rate-Limit-Limit, X-Rate-Limit-Reset, X-Rate-Limit-Remaining)
+  #
+  # @return [Hashie::Mash]
+  def find_payment_period(id:, &block)
+    get("/payment_periods/#{id}", &block)
+  end
+
+  # Get the list of payment periods
+  #
+  # @see https://developer.smarthr.jp/api/index.html#!/%E7%B5%A6%E4%B8%8E%E6%94%AF%E7%B5%A6%E5%BD%A2%E6%85%8B/getV1PaymentPeriods
+  #
+  # @param page     [Integer]
+  # @param per_page [Integer]
+  #
+  # @yield [response_body, response_header] if block was given, return response body and response header through block arguments
+  # @yieldparam response_body [Array<Hashie::Mash>] response body
+  # @yieldparam response_header [Hash<String, String>] response header (e.g. X-Rate-Limit-Limit, X-Rate-Limit-Reset, X-Rate-Limit-Remaining)
+  #
+  # @return [Array<Hashie::Mash>]
+  def get_payment_periods(page: 1, per_page: 10, &block)
+    get("/payment_periods",
+      page: page,
+      per_page: per_page,
+      &block
+    )
+  end
+end

data/lib/smarthr/client/user_methods.rb

@@ -0,0 +1,39 @@
+module SmartHR::Client::UserMethods
+  # Get the user
+  #
+  # @see https://developer.smarthr.jp/api/index.html#!/%E3%83%A6%E3%83%BC%E3%82%B6/getV1UsersId
+  #
+  # @param id         [String]
+  # @param embed_crew [Boolean] Whether or not to embed crews
+  #
+  # @yield [response_body, response_header] if block was given, return response body and response header through block arguments
+  # @yieldparam response_body [Hashie::Mash] response body
+  # @yieldparam response_header [Hash<String, String>] response header (e.g. X-Rate-Limit-Limit, X-Rate-Limit-Reset, X-Rate-Limit-Remaining)
+  #
+  # @return [Hashie::Mash]
+  def find_user(id:, embed_crew: false, &block)
+    get("/users/#{id}", embed: embed_crew ? 'crew' : nil, &block)
+  end
+
+  # Get the list of users
+  #
+  # @see https://developer.smarthr.jp/api/index.html#!/%E3%83%A6%E3%83%BC%E3%82%B6/getV1Users
+  #
+  # @param page       [Integer]
+  # @param per_page   [Integer]
+  # @param embed_crew [Boolean] Whether or not to embed crews
+  #
+  # @yield [response_body, response_header] if block was given, return response body and response header through block arguments
+  # @yieldparam response_body [Array<Hashie::Mash>] response body
+  # @yieldparam response_header [Hash<String, String>] response header (e.g. X-Rate-Limit-Limit, X-Rate-Limit-Reset, X-Rate-Limit-Remaining)
+  #
+  # @return [Array<Hashie::Mash>]
+  def get_users(page: 1, per_page: 10, embed_crew: false, &block)
+    get("/users",
+      page: page,
+      per_page: per_page,
+      embed: embed_crew ? 'crew' : nil,
+      &block
+    )
+  end
+end

data/lib/smarthr/client/webhook_methods.rb

@@ -0,0 +1,80 @@
+module SmartHR::Client::WebhookMethods
+  # Delete the webhook
+  #
+  # @see https://developer.smarthr.jp/api/index.html#!/Webhook/deleteV1WebhooksId
+  #
+  # @param id [String]
+  #
+  # @yield [response_body, response_header] if block was given, return response body and response header through block arguments
+  # @yieldparam response_body [Hashie::Mash] response body
+  # @yieldparam response_header [Hash<String, String>] response header (e.g. X-Rate-Limit-Limit, X-Rate-Limit-Reset, X-Rate-Limit-Remaining)
+  def destroy_webhook(id:, &block)
+    delete("/webhooks/#{id}", &block)
+  end
+
+  # Get the webhook
+  #
+  # @see https://developer.smarthr.jp/api/index.html#!/Webhook/getV1WebhooksId
+  #
+  # @param id [String]
+  #
+  # @yield [response_body, response_header] if block was given, return response body and response header through block arguments
+  # @yieldparam response_body [Hashie::Mash] response body
+  # @yieldparam response_header [Hash<String, String>] response header (e.g. X-Rate-Limit-Limit, X-Rate-Limit-Reset, X-Rate-Limit-Remaining)
+  #
+  # @return [Hashie::Mash]
+  def find_webhook(id:, &block)
+    get("/webhooks/#{id}", &block)
+  end
+
+  # Change the data of the specified webhook
+  #
+  # @see https://developer.smarthr.jp/api/index.html#!/Webhook/patchV1WebhooksId
+  #
+  # @param id   [String]
+  # @param body [Hash]
+  #
+  # @yield [response_body, response_header] if block was given, return response body and response header through block arguments
+  # @yieldparam response_body [Hashie::Mash] response body
+  # @yieldparam response_header [Hash<String, String>] response header (e.g. X-Rate-Limit-Limit, X-Rate-Limit-Reset, X-Rate-Limit-Remaining)
+  #
+  # @return [Hashie::Mash]
+  def update_webhook(id:, body:, &block)
+    patch("/webhooks/#{id}", body, &block)
+  end
+
+  # Get the list of webhooks
+  #
+  # @see https://developer.smarthr.jp/api/index.html#!/Webhook/getV1Webhooks
+  #
+  # @param page     [Integer]
+  # @param per_page [Integer]
+  #
+  # @yield [response_body, response_header] if block was given, return response body and response header through block arguments
+  # @yieldparam response_body [Array<Hashie::Mash>] response body
+  # @yieldparam response_header [Hash<String, String>] response header (e.g. X-Rate-Limit-Limit, X-Rate-Limit-Reset, X-Rate-Limit-Remaining)
+  #
+  # @return [Array<Hashie::Mash>]
+  def get_webhooks(page: 1, per_page: 10, &block)
+    get("/webhooks",
+      page: page,
+      per_page: per_page,
+      &block
+    )
+  end
+
+  # Create a new webhook
+  #
+  # @see https://developer.smarthr.jp/api/index.html#!/Webhook/postV1Webhooks
+  #
+  # @param body [Hash]
+  #
+  # @yield [response_body, response_header] if block was given, return response body and response header through block arguments
+  # @yieldparam response_body [Hashie::Mash] response body
+  # @yieldparam response_header [Hash<String, String>] response header (e.g. X-Rate-Limit-Limit, X-Rate-Limit-Reset, X-Rate-Limit-Remaining)
+  #
+  # @return [Hashie::Mash]
+  def create_webhook(body:, &block)
+    post("/webhooks", body, &block)
+  end
+end

data/lib/smarthr/converter.rb

@@ -0,0 +1,7 @@
+module SmartHR
+  module Converter
+    def hash_compact(hash)
+      hash.reject { |_k, v| v.nil? }
+    end
+  end
+end

data/lib/smarthr/version.rb

@@ -0,0 +1,3 @@
+module SmartHR
+  VERSION = "0.0.1".freeze
+end

data/smarthr.gemspec

@@ -0,0 +1,31 @@
+require_relative 'lib/smarthr/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "smarthr"
+  spec.version       = SmartHR::VERSION
+  spec.authors       = ["Proxyworks, Inc."]
+  spec.email         = ["tsuji@proxyworks.co.jp"]
+
+  spec.summary       = "SmartHR SDK for Ruby"
+  spec.description   = "Ruby bindings of SmartHR API"
+  spec.homepage      = "https://github.com/proxyworks-inc/smarthr-ruby"
+  spec.license       = "MIT"
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.3.0")
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/proxyworks-inc/smarthr-ruby"
+  spec.metadata["changelog_uri"] = "https://github.com/proxyworks-inc/smarthr-ruby/blob/main/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", ">= 0.9"
+  spec.add_dependency "faraday_middleware"
+  spec.add_dependency "hashie"
+end

metadata

@@ -0,0 +1,113 @@
+--- !ruby/object:Gem::Specification
+name: smarthr
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Proxyworks, Inc.
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2021-06-23 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.9'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.9'
+- !ruby/object:Gem::Dependency
+  name: faraday_middleware
+  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: hashie
+  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'
+description: Ruby bindings of SmartHR API
+email:
+- tsuji@proxyworks.co.jp
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- CHANGELOG.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- lib/smarthr.rb
+- lib/smarthr/client.rb
+- lib/smarthr/client/bank_account_setting_methods.rb
+- lib/smarthr/client/biz_establishment_methods.rb
+- lib/smarthr/client/crew_custom_field_template_group_methods.rb
+- lib/smarthr/client/crew_custom_field_template_methods.rb
+- lib/smarthr/client/crew_input_form_method.rb
+- lib/smarthr/client/crew_methods.rb
+- lib/smarthr/client/department_methods.rb
+- lib/smarthr/client/dependent_methods.rb
+- lib/smarthr/client/dependent_relation_methods.rb
+- lib/smarthr/client/employment_type_methods.rb
+- lib/smarthr/client/job_title_methods.rb
+- lib/smarthr/client/mail_format_methods.rb
+- lib/smarthr/client/payment_period_methods.rb
+- lib/smarthr/client/user_methods.rb
+- lib/smarthr/client/webhook_methods.rb
+- lib/smarthr/converter.rb
+- lib/smarthr/version.rb
+- smarthr.gemspec
+homepage: https://github.com/proxyworks-inc/smarthr-ruby
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/proxyworks-inc/smarthr-ruby
+  source_code_uri: https://github.com/proxyworks-inc/smarthr-ruby
+  changelog_uri: https://github.com/proxyworks-inc/smarthr-ruby/blob/main/CHANGELOG.md
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.6
+signing_key: 
+specification_version: 4
+summary: SmartHR SDK for Ruby
+test_files: []