jbcn 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 951525ccc503519e49cb98ada2ac871fdae43d82
+  data.tar.gz: 620abb4e2d0230396e5648ba024c7bc1e0366333
+SHA512:
+  metadata.gz: aa9357f5df69aa3d078a536ae6e95ffee28a2e98d4ad3ccd446d4aaf208374cfa35dfd1d4076667736b37e3ebac4b3e5d10479ee914eebd646e5540f78808461
+  data.tar.gz: b595c710692edc242bd000b54afe975b1363170bb0bcb4fe32bb4115a3b7d9239b83f978eb8e5e5076f8e8f16382098c519b78d895c6b3a34bc3ff94a4c3df75

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Tomoki Aonuma
+
+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,51 @@
+# Jbcn
+
+Jbcn is a client for [Jobcan](http://jobcan.ne.jp).
+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'jbcn'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install jbcn
+
+## Usage
+
+```
+require "jbcn"
+
+client = Jbcn::Client.new
+client.authenticate(code: "your code goes here")
+
+# Clock in/out
+client.clock(:in, group_id: "1")
+p client.clock(:out, group_id: "1")
+# => {"result"=>1, "state"=>"4", "current_status"=>"returned_home"}
+
+# Clock in with extra info
+client.clock(:in, group_id: "1", note: "my first night shift", night_shift: true)
+```
+
+## 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 tags, 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/uasi/jbcn.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "jbcn"
+
+# 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

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/jbcn.gemspec

@@ -0,0 +1,30 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'jbcn/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "jbcn"
+  spec.version       = Jbcn::VERSION
+  spec.authors       = ["Tomoki Aonuma"]
+  spec.email         = ["uasi@uasi.jp"]
+
+  spec.summary       = %q{Client for Jobcan}
+  spec.description   = %q{Client for Jobcan}
+  spec.homepage      = "https://github.com/uasi/jbcn"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |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_development_dependency "bundler", "~> 1.13"
+  spec.add_development_dependency "rake", "~> 10.0"
+
+  spec.add_dependency "faraday", "~> 0.10"
+  spec.add_dependency "faraday_middleware", "~> 0.10"
+  spec.add_dependency "faraday-cookie_jar", "~> 0.0.6"
+end

data/lib/jbcn/client.rb

@@ -0,0 +1,66 @@
+# frozen_string_literal: true
+
+module Jbcn
+  class Client
+    CLOCK_ENDPOINT = "https://ssl.jobcan.jp/employee/index/adit"
+
+    def authenticate(credentials)
+      if credentials.is_a?(Hash) && (code = credentials[:code])
+        credentials = CodeCredentials.new(code)
+      end
+      @token = credentials.authenticate(faraday)
+    end
+
+    def clock(in_out, group_id:, note: "", night_shift: false)
+      unless @token
+        fail(RuntimeError, "not authenticated")
+      end
+      unless [:in, :out].include?(in_out)
+        fail(ArgumentError, "expected :in or :out")
+      end
+
+      params = build_params(in_out, group_id.to_s, note.to_s, !!night_shift)
+      response = faraday.post(CLOCK_ENDPOINT, params) rescue fail(ClockError)
+
+      # Jobcan would normally return responses with status code 200
+      # regardless of whether the request was success or not,
+      # so status != 200 is really an unexpected condition.
+      unless response.status == 200
+        fail(ClockError.new(response: response))
+      end
+
+      result = JSON.parse(response.body) rescue
+        fail(ClockResponseParseError.new(response: response))
+
+      if result["errors"]
+        if result["errors"]["aditCount"] == "duplicate"
+          fail(ClockRequestDuplicateError.new(response: response, result: result))
+        end
+        fail(ClockError.new(response: response, result: result))
+      end
+
+      result
+    end
+
+    private
+
+    def build_params(in_out, group_id, note, night_shift)
+      {
+        adit_item: in_out == :in ? "work_start" : "work_end",
+        adit_group_id: group_id,
+        notice: note,
+        is_yakin: night_shift ? "1" : "0",
+        token: @token,
+      }
+    end
+
+    def faraday
+      @faraday ||= Faraday.new do |builder|
+        builder.request :url_encoded
+        builder.use FaradayMiddleware::FollowRedirects
+        builder.use :cookie_jar
+        builder.adapter Faraday.default_adapter
+      end
+    end
+  end
+end

data/lib/jbcn/credentials.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+module Jbcn
+  class Credentials
+    attr_reader :token
+
+    def authenticate(_faraday)
+      fail(NotImplementedError)
+    end
+  end
+
+  class CodeCredentials < Credentials
+    AUTH_ENDPOINT = "https://ssl.jobcan.jp/employee?code="
+
+    attr_reader :code
+
+    def initialize(code)
+      @code = code
+    end
+
+    def authenticate(faraday)
+      response = faraday.get(AUTH_ENDPOINT + @code) rescue fail(AuthError)
+
+      unless response.status == 200
+        fail(AuthError, response: response)
+      end
+
+      token = response.body[/<input type="hidden" class="token" name="token" value="([^"]+)">/, 1]
+      unless token
+        fail(AuthTokenNotFoundError, response: response)
+      end
+
+      token
+    end
+  end
+
+  # TODO
+  #class UserCredentials < Credentials
+  #end
+end

data/lib/jbcn/error.rb

@@ -0,0 +1,61 @@
+# frozen_string_literal: true
+
+module Jbcn
+  class Error < StandardError
+  end
+
+  class AuthError < Error
+    attr_reader :response
+
+    def initialize(message = nil, response: nil)
+      super(message || default_message)
+      @response = response
+    end
+
+    private
+
+    def default_message
+      "auth failed"
+    end
+  end
+
+  class AuthTokenNotFoundError < AuthError
+    private
+
+    def default_message
+      "token not found (maybe jobcan's html structure has changed)"
+    end
+  end
+
+  class ClockError < Error
+    attr_reader :response, :result
+
+    def initialize(message = nil, response: nil, result: nil)
+      super(message || default_message)
+      @response = response
+      @result = result
+    end
+
+    private
+
+    def default_message
+      "request failed"
+    end
+  end
+
+  class ClockResponseParseError < ClockError
+    private
+
+    def default_message
+      "could not parse response"
+    end
+  end
+
+  class ClockRequestDuplicateError < ClockError
+    private
+
+    def default_message
+      "duplicate request"
+    end
+  end
+end

data/lib/jbcn/version.rb

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

data/lib/jbcn.rb

@@ -0,0 +1,9 @@
+require "faraday"
+require "faraday_middleware"
+require "faraday-cookie_jar"
+require "json"
+
+require "jbcn/version"
+require "jbcn/error"
+require "jbcn/credentials"
+require "jbcn/client"

metadata

@@ -0,0 +1,127 @@
+--- !ruby/object:Gem::Specification
+name: jbcn
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Tomoki Aonuma
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-12-26 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+- !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: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+- !ruby/object:Gem::Dependency
+  name: faraday_middleware
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+- !ruby/object:Gem::Dependency
+  name: faraday-cookie_jar
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.0.6
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.0.6
+description: Client for Jobcan
+email:
+- uasi@uasi.jp
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- jbcn.gemspec
+- lib/jbcn.rb
+- lib/jbcn/client.rb
+- lib/jbcn/credentials.rb
+- lib/jbcn/error.rb
+- lib/jbcn/version.rb
+homepage: https://github.com/uasi/jbcn
+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.6.8
+signing_key: 
+specification_version: 4
+summary: Client for Jobcan
+test_files: []