smarthr 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 863f1a89c94dfde946b0fcf6c7dbdabd92ea0169bf3185c9ec8c3999606a50e9
+  data.tar.gz: 261cf19e10e729459df13d497c266e8ea58659c14fab1422dd21ae5f7b7d3215
+SHA512:
+  metadata.gz: 890a06f5acb6ca5ba072a43017aeffaa398ca2f71cf664afbe5b7219c85c84749462f336a19863ffdb9e101c94140e4b9c8322a8b5bdbfa158713183f03e3d9f
+  data.tar.gz: 3a123c367118fb0626b75bc225f21cb5ff1c43ccfce1b5512982981fe1b21d48049da182b65adc3af87cdaf5f4664696e965b5c87de03dc7e2e35d622848758b

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/CHANGELOG.md

@@ -0,0 +1,6 @@
+# Changelog
+
+
+## [v0.0.1](https://github.com/proxyworks-inc/smarthr-ruby/tree/v0.0.1)
+
+\* *This Changelog was automatically generated by [github_changelog_generator](https://github.com/github-changelog-generator/github-changelog-generator)*

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2021 Proxyworks, Inc.
+
+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,48 @@
+# SmartHR
+
+Ruby bindings of SmartHR API
+
+## Installation
+
+```ruby
+gem 'smarthr'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install smarthr
+
+## Usage
+
+```ruby
+client = SmartHR::Client.new(tenant_id: "XXX", access_token: "XXX")
+# for Sandbox
+client = SmartHR::Client.new(tenant_id: "XXX", access_token: "XXX", sandbox: true)
+```
+
+Then call instance methods.
+
+e.g. find crew.
+
+```
+client.find_crew(id: '906494aa-11bf-4324-91ea-6a07aad172d0')
+#=> #<Hashie::Mash id="906494aa-11bf-4324-91ea-6a07aad172d0">
+```
+
+
+## Contributing
+
+1. Fork it
+1. Create your feature branch (`git checkout -b my-new-feature`)
+1. Commit your changes (`git commit -am 'Add some feature'`)
+1. Push to the branch (`git push origin my-new-feature`)
+1. Create new Pull Request
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/lib/smarthr.rb

@@ -0,0 +1,39 @@
+require "smarthr/version"
+
+module SmartHR
+  autoload :Client, "smarthr/client"
+  autoload :Converter, "smarthr/converter"
+
+  class Error < StandardError
+    def self.from_response(status, body)
+      APIConnectionError.new("Invalid response #{body.to_hash} (status: #{status})")
+    end
+
+    attr_reader :status
+    attr_reader :error_response
+
+    def initialize(message, status = nil, error_response = nil)
+      @status = status
+      @error_response = error_response
+      super(message)
+    end
+  end
+
+  class APIConnectionError < SmartHR::Error
+    def self.faraday_error(e)
+      new("Connection with SmartHR API server failed. #{e.message}", e)
+    end
+
+    attr_reader :original_error
+
+    def initialize(message, original_error = nil)
+      @original_error = original_error
+
+      if original_error && original_error.response.is_a?(Hash)
+        super(message, original_error.response[:status], original_error.response[:body])
+      else
+        super(message)
+      end
+    end
+  end
+end

data/lib/smarthr/client.rb

@@ -0,0 +1,89 @@
+require "faraday"
+require "faraday_middleware"
+
+module SmartHR
+  class Client
+    require "smarthr/client/bank_account_setting_methods"
+    require "smarthr/client/biz_establishment_methods"
+    require "smarthr/client/crew_custom_field_template_group_methods"
+    require "smarthr/client/crew_custom_field_template_methods"
+    require "smarthr/client/crew_input_form_method"
+    require "smarthr/client/crew_methods"
+    require "smarthr/client/department_methods"
+    require "smarthr/client/dependent_methods"
+    require "smarthr/client/dependent_relation_methods"
+    require "smarthr/client/employment_type_methods"
+    require "smarthr/client/job_title_methods"
+    require "smarthr/client/mail_format_methods"
+    require "smarthr/client/payment_period_methods"
+    require "smarthr/client/user_methods"
+    require "smarthr/client/webhook_methods"
+
+    include Converter
+    include BankAccountSettingMethods
+    include BizEstablishmentMethods
+    include CrewCustomFieldTemplateGroupMethods
+    include CrewCustomFieldTemplateMethods
+    include CrewInputFormMethods
+    include CrewMethods
+    include DepartmentMethods
+    include DependentMethods
+    include DependentRelationMethods
+    include EmploymentTypeMethods
+    include JobTitleMethods
+    include MailFormatMethods
+    include PaymentPeriodMethods
+    include UserMethods
+    include WebhookMethods
+
+    def initialize(tenant_id: nil, access_token: nil, sandbox: false, header: {}, api_version: 'v1')
+      raise unless tenant_id
+      raise unless access_token
+
+      url = sprintf(sandbox ? "https://%s.daruma.space/api/" : "https://%s.smarthr.jp/api/", tenant_id)
+      header.merge!({
+        "User-Agent" => "SmartHR/#{api_version} RubyBinding/#{SmartHR::VERSION}",
+        "Authorization" => "Bearer #{access_token}"
+      })
+
+      @conn = Faraday.new(url, headers: header) do |builder|
+        builder.request :url_encoded
+        builder.response :mashify
+        builder.response :json
+        builder.adapter Faraday.default_adapter
+      end
+      @api_version = api_version
+    end
+
+    def handle_response(response)
+      case response.status
+      when 200..299
+        response.body
+      else
+        puts response.status
+        puts response.body
+        raise SmartHR::Error.from_response(response.status, response.body)
+      end
+    end
+
+    Faraday::Connection::METHODS.each do |method|
+      define_method(method) do |url, args = {}, &block|
+        faraday_errors =
+          if Gem::Version.create(Faraday::VERSION) >= Gem::Version.create("1.0.0")
+            [Faraday::ClientError, Faraday::ServerError]
+          else
+            [Faraday::Error::ClientError]
+          end
+
+        begin
+          response = @conn.__send__(method, @api_version + url, hash_compact(args))
+        rescue *faraday_errors => e
+          raise SmartHR::APIConnectionError.faraday_error(e)
+        end
+        payload = handle_response(response)
+        block.call(payload, response.headers) if block
+        payload
+      end
+    end
+  end
+end

data/lib/smarthr/client/bank_account_setting_methods.rb

@@ -0,0 +1,21 @@
+module SmartHR::Client::BankAccountSettingMethods
+  # Get the list of bank account settings
+  #
+  # @see https://developer.smarthr.jp/api/index.html#!/%E5%8F%A3%E5%BA%A7%E6%83%85%E5%A0%B1/getV1BankAccountSettings
+  #
+  # @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_bank_account_settings(page: 1, per_page: 10, &block)
+    get("/bank_account_settings",
+      page: page,
+      per_page: per_page,
+      &block
+    )
+  end
+end

data/lib/smarthr/client/biz_establishment_methods.rb

@@ -0,0 +1,27 @@
+module SmartHR::Client::BizEstablishmentMethods
+  # Get the list of business establishments
+  #
+  # @see https://developer.smarthr.jp/api/index.html#!/%E4%BA%8B%E6%A5%AD%E6%89%80/getV1BizEstablishments
+  #
+  # @param page                [Integer]
+  # @param per_page            [Integer]
+  # @param embed_soc_ins_owner [Boolean] Whether or not to embed social insurance owner
+  # @param embed_lab_ins_owner [Boolean] Whether or not to embed labor insurance owner
+  #
+  # @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_biz_establishments(page: 1, per_page: 10, embed_soc_ins_owner: false, embed_lab_ins_owner: false, &block)
+    embed = embed_soc_ins_owner ? 'soc_ins_owner' : nil
+    embed = embed_lab_ins_owner ? 'lab_ins_owner' : nil
+
+    get("/biz_establishments",
+      page: page,
+      per_page: per_page,
+      embed: embed,
+      &block
+    )
+  end
+end

data/lib/smarthr/client/crew_custom_field_template_group_methods.rb

@@ -0,0 +1,83 @@
+module SmartHR::Client::CrewCustomFieldTemplateGroupMethods
+  # Delete the crew custom field template group
+  #
+  # @see https://developer.smarthr.jp/api/index.html#!/%E5%BE%93%E6%A5%AD%E5%93%A1%E3%82%AB%E3%82%B9%E3%82%BF%E3%83%A0%E9%A0%85%E7%9B%AE%E3%82%B0%E3%83%AB%E3%83%BC%E3%83%97/deleteV1CrewCustomFieldTemplateGroupsId
+  #
+  # @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_crew_custom_field_template_group(id:, &block)
+    delete("/crew_custom_field_template_groups/#{id}", &block)
+  end
+
+  # Get the crew custom field template group
+  #
+  # @see https://developer.smarthr.jp/api/index.html#!/%E5%BE%93%E6%A5%AD%E5%93%A1%E3%82%AB%E3%82%B9%E3%82%BF%E3%83%A0%E9%A0%85%E7%9B%AE%E3%82%B0%E3%83%AB%E3%83%BC%E3%83%97/getV1CrewCustomFieldTemplateGroupsId
+  #
+  # @param id              [String]
+  # @param embed_templates [Boolean] Whether or not to embed templates
+  #
+  # @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_crew_custom_field_template_group(id:, embed_templates: false, &block)
+    get("/crew_custom_field_template_groups/#{id}", embed: embed_templates ? 'templates' : nil, &block)
+  end
+
+  # Change the data of the specified group
+  #
+  # @see https://developer.smarthr.jp/api/index.html#!/%E5%BE%93%E6%A5%AD%E5%93%A1%E3%82%AB%E3%82%B9%E3%82%BF%E3%83%A0%E9%A0%85%E7%9B%AE%E3%82%B0%E3%83%AB%E3%83%BC%E3%83%97/getV1CrewCustomFieldTemplateGroupsId
+  #
+  # @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_crew_custom_field_template_group(id:, body:, &block)
+    patch("/crew_custom_field_template_groups/#{id}", body, &block)
+  end
+
+  # Get the list of crew custom field template groups
+  #
+  # @see https://developer.smarthr.jp/api/index.html#!/%E5%BE%93%E6%A5%AD%E5%93%A1%E3%82%AB%E3%82%B9%E3%82%BF%E3%83%A0%E9%A0%85%E7%9B%AE%E3%82%B0%E3%83%AB%E3%83%BC%E3%83%97/getV1CrewCustomFieldTemplateGroups
+  #
+  # @param page            [Integer]
+  # @param per_page        [Integer]
+  # @param embed_templates [Boolean] Whether or not to embed templates
+  #
+  # @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_crew_custom_field_template_groups(page: 1, per_page: 10, embed_templates: false, &block)
+    get("/crew_custom_field_template_groups",
+      page: page,
+      per_page: per_page,
+      embed: embed_templates ? 'templates' : nil,
+      &block
+    )
+  end
+
+  # Create a new crew custom field template group
+  #
+  # @see https://developer.smarthr.jp/api/index.html#!/%E5%BE%93%E6%A5%AD%E5%93%A1%E3%82%AB%E3%82%B9%E3%82%BF%E3%83%A0%E9%A0%85%E7%9B%AE%E3%82%B0%E3%83%AB%E3%83%BC%E3%83%97/postV1CrewCustomFieldTemplateGroups
+  #
+  # @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_crew_custom_field_template_group(body:, &block)
+    post("/crew_custom_field_template_groups", body, &block)
+  end
+end

data/lib/smarthr/client/crew_custom_field_template_methods.rb

@@ -0,0 +1,83 @@
+module SmartHR::Client::CrewCustomFieldTemplateMethods
+  # Delete the crew custom field template
+  #
+  # @see https://developer.smarthr.jp/api/index.html#!/%E5%BE%93%E6%A5%AD%E5%93%A1%E3%82%AB%E3%82%B9%E3%82%BF%E3%83%A0%E9%A0%85%E7%9B%AE%E3%83%86%E3%83%B3%E3%83%97%E3%83%AC%E3%83%BC%E3%83%88/deleteV1CrewCustomFieldTemplatesId
+  #
+  # @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_crew_custom_field_template(id:, &block)
+    delete("/crew_custom_field_templates/#{id}", &block)
+  end
+
+  # Get the crew custom field template
+  #
+  # @see https://developer.smarthr.jp/api/index.html#!/%E5%BE%93%E6%A5%AD%E5%93%A1%E3%82%AB%E3%82%B9%E3%82%BF%E3%83%A0%E9%A0%85%E7%9B%AE%E3%83%86%E3%83%B3%E3%83%97%E3%83%AC%E3%83%BC%E3%83%88/getV1CrewCustomFieldTemplatesId
+  #
+  # @param id          [String]
+  # @param embed_group [Boolean] Whether or not to embed group
+  #
+  # @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_crew_custom_field_template(id:, embed_group: false, &block)
+    get("/crew_custom_field_templates/#{id}", embed: embed_group ? 'group' : nil, &block)
+  end
+
+  # Change the data of the specified template
+  #
+  # @see https://developer.smarthr.jp/api/index.html#!/%E5%BE%93%E6%A5%AD%E5%93%A1%E3%82%AB%E3%82%B9%E3%82%BF%E3%83%A0%E9%A0%85%E7%9B%AE%E3%83%86%E3%83%B3%E3%83%97%E3%83%AC%E3%83%BC%E3%83%88/patchV1CrewCustomFieldTemplatesId
+  #
+  # @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_crew_custom_field_template(id:, body:, &block)
+    patch("/crew_custom_field_templates/#{id}", body, &block)
+  end
+
+  # Get the list of crew custom field templates
+  #
+  # @see https://developer.smarthr.jp/api/index.html#!/%E5%BE%93%E6%A5%AD%E5%93%A1%E3%82%AB%E3%82%B9%E3%82%BF%E3%83%A0%E9%A0%85%E7%9B%AE%E3%83%86%E3%83%B3%E3%83%97%E3%83%AC%E3%83%BC%E3%83%88/getV1CrewCustomFieldTemplates
+  #
+  # @param page        [Integer]
+  # @param per_page    [Integer]
+  # @param embed_group [Boolean] Whether or not to embed group
+  #
+  # @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_crew_custom_field_templates(page: 1, per_page: 10, embed_group: false, &block)
+    get("/crew_custom_field_templates",
+      page: page,
+      per_page: per_page,
+      embed: embed_group ? 'group' : nil,
+      &block
+    )
+  end
+
+  # Create a new crew custom field template
+  #
+  # @see https://developer.smarthr.jp/api/index.html#!/%E5%BE%93%E6%A5%AD%E5%93%A1%E3%82%AB%E3%82%B9%E3%82%BF%E3%83%A0%E9%A0%85%E7%9B%AE%E3%83%86%E3%83%B3%E3%83%97%E3%83%AC%E3%83%BC%E3%83%88/postV1CrewCustomFieldTemplates
+  #
+  # @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_crew_custom_field_template(body:, &block)
+    post("/crew_custom_field_templates", body, &block)
+  end
+end