ruboty-jobcan 0.1.1 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 56f732325b542a73278f169be504638eec2e63b3
-  data.tar.gz: 560c033f3d6a14bd87988b4acc23dc1cd51c5ba9
+  metadata.gz: 73e500010b3adf3025367661723360fa555e24b4
+  data.tar.gz: 4c29f7959546bb61e86d07401c320d4a0aab2e87
 SHA512:
-  metadata.gz: 42bdd99cf2618c0a17e426bddee6a9b6ee6875a5c8722fec208ef0d577ed32dc2b2b79ba0e35df55f74791e3d0541bcd18bcb0b35448f0b5dd60fa422c68d09e
-  data.tar.gz: 97a11cb46f5ce519e0b1ed6961d939667a32d4f15458d12861e8fe9c6da001fab56a6edc943566f5d7a1c0eda2142d996e09ef2005401f16dbd24f56d57574ec
+  metadata.gz: 9c43a02dfd75f6538fa8238c640bf1612696540d07d92ce3feae3459668bd42aa55a70617728bfcfd6baf3c5afba870a247a8fb381ab22c7542db1dccfabc397
+  data.tar.gz: bd5a0dbce45340ec74b456d0a9bf192c097d9e2e732c4b2fcab5703e7e943a945b1653f8816a021596ca831f2f32571a339896d30ceb72ed29e360a48b0df38c

data/README.md

@@ -1,13 +1,60 @@
 # Ruboty::Jobcan
 
+## Usage
+
+To use JOBCAN API, you have to teach Ruboty either your code or login info.
+
+### Teach JOBCAN code
+
 ```
 ruboty remember my jobcan code <code>
+```
+
+`<code>` is the text attached to your mobile login URL,
+e.g. `http://jobcan.jp/m?code=YOUR_CODE_GOES_HERE`.
+Check out the invitation email from JOBCAN for the URL.
+
+
+### Teach client ID, email, and password
+
+Alternatively, you can use these environment variables to provide your credentials.
+
+```
+RUBOTY_JOBCAN_CLIENT_ID
+RUBOTY_JOBCAN_EMAIL
+RUBOTY_JOBCAN_PASSWORD
+```
+
+### Set group ID
+
+Then set your default group ID.
+
+```
 ruboty remember my jobcan group id <group_id>
-ruboty punch the clock
 ```
 
-## Installation
+`<group_id>` is the numeric ID of your group;
+ask your manager or check out the source code of https://ssl.jobcan.jp/employee for it.
+
+![group ID](img/group_id.png)
+
+
+You can also use group name aliases.
+
+```
+ruboty register my jobcan group alias <group_name> -> <group_id>
+```
+
+### Clock in/out
 
+```
+ruboty clock in
+ruboty clock out
+ruboty clock in at <group_name>
+ruboty clock out at <group_name>
+```
+
+## Installation
 
 ```ruby
 gem 'ruboty-jobcan'
@@ -29,5 +76,4 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/ruboty-jobcan.
-
+Bug reports and pull requests are welcome on GitHub at https://github.com/uasi/ruboty-jobcan.

data/lib/ruboty/actions/jobcan.rb

@@ -1,5 +1,7 @@
 require "faraday"
+require "faraday_middleware"
 require "faraday-cookie_jar"
+require "jbcn"
 
 module Ruboty
   module Actions
@@ -22,99 +24,82 @@ module Ruboty
         message.reply("I remember.")
       end
 
-      def punch_clock(in_out = :auto)
-        unless (code = user_data["code"])
-          message.reply("I don't know your JOBCAN code.")
-          return
-        end
-        unless (group_id = user_data["group_id"])
-          message.reply("I don't know your JOBCAN group ID.")
-          return
-        end
-        client = JobcanClient.new(code, group_id, in_out)
-        client.authenticate!
-        status = client.punch_clock!
-        message.reply("OK, your current status is #{status}.")
-      rescue
-        message.reply("Error: #{$!}")
+      def register_group_alias
+        user_data["alias_#{message[:group_name]}"] = message[:group_id]
+        message.reply("I registered alias #{message[:group_name]} to ID #{message[:group_id]}.")
       end
 
-      def clock_in
-        punch_clock(:in)
-      end
-
-      def clock_out
-        punch_clock(:out)
-      end
-
-      private
-
-      def user_data
-        brain_space = message.robot.brain.data[NAMESPACE] ||= {}
-        brain_space[message.from_name] ||= {}
-      end
-
-      class JobcanClient
-        def initialize(code, group_id, in_out)
-          @code = code
-          @group_id = group_id
-          @in_out = in_out
+      def clock_in_out
+        unless client
+          message.reply("I don't know your JOBCAN login info.")
+          return
         end
 
-        def authenticate!
-          response = faraday.get(authenticate_url)
-          unless response.status == 200
-            fail "could not log in to JOBCAN; it returned #{response.status}"
+        if (group_name = message[:group_name])
+          unless (group_id = user_data["alias_#{group_name}"])
+            message.reply("I don't know that JOBCAN group alias '#{group_name}'.")
+            return
+          end
+        else
+          unless (group_id = user_data["group_id"])
+            message.reply("I don't know your JOBCAN group ID.")
+            return
           end
         end
 
-        def punch_clock!
-          response = faraday.post(punch_clock_url, punch_clock_request_body)
-          unless response.status == 200
-            fail "could not punch the clock on JOBCAN; it returned #{response.status}"
-          end
-          result = JSON.parse(response.body) or fail "could not parse response"
-          if result["result"] == 0
-            if result["errors"] && result["errors"]["aditCount"] == "duplicate"
-              fail "you have punched the clock within a minute"
-            end
-            fail result["errors"].to_s
-          end
-          result["current_status"]
+        result = client.clock(message[:in_out].to_sym, group_id: group_id)
+        unless result.is_a?(Hash) && (current_status = result["current_status"])
+          message.reply("I got unknown response from JOBCAN: #{result}.")
+          return
         end
 
-        private
+        message.reply("OK, your current status is #{current_status}.")
+      end
+
+      private
 
-        def faraday
-          @faraday ||= Faraday.new do |builder|
-            # Note that the server will return JSON string with text/html content type.
-            # Don't use `builder.response :json` here.
-            builder.request :url_encoded
-            builder.use FaradayMiddleware::FollowRedirects
-            builder.use :cookie_jar
-            builder.adapter Faraday.default_adapter
+      def client
+        unless instance_variable_defined?(:@client)
+          if (credentials = code_credentials || user_credentials)
+            @client = Jbcn::Client.new
+            @client.authenticate(credentials)
+          else
+            @client = nil
           end
         end
+        @client
+      end
 
-        def authenticate_url
-          "https://ssl.jobcan.jp/employee?code=#{@code}"
+      def code_credentials
+        if (code = user_data["code"])
+          Jbcn::CodeCredentials.new(code)
+        else
+          nil
         end
+      end
 
-        def punch_clock_url
-          "https://ssl.jobcan.jp/employee/index/adit"
+      def user_credentials
+        if login_env_present?
+          Jbcn::UserCredentials.new(
+            client_id: ENV["RUBOTY_JOBCAN_CLIENT_ID"],
+            username: ENV["RUBOTY_JOBCAN_USERNAME"] || ENV["RUBOTY_JOBCAN_EMAIL"],
+            password: ENV["RUBOTY_JOBCAN_PASSWORD"])
+        else
+          nil
         end
+      end
 
-        def punch_clock_request_body
-          { is_yakin: "0", adit_item: adit_item, adit_group_id: @group_id, notice: "" }
-        end
+      def user_data
+        brain_space = message.robot.brain.data[NAMESPACE] ||= {}
+        brain_space[message.from_name] ||= {}
+      end
 
-        def adit_item
-          case @in_out
-          when :auto then "DEF"
-          when :in then "work_start"
-          when :out then "work_end"
-          end
-        end
+      def login_env_present?
+        !!(
+          ENV["RUBOTY_JOBCAN_CLIENT_ID"] &&
+          ENV["RUBOTY_JOBCAN_PASSWORD"] &&
+          (ENV["RUBOTY_JOBCAN_USERNAME"] || ENV["RUBOTY_JOBCAN_EMAIL"])
+        )
       end
     end
   end

data/lib/ruboty/handlers/jobcan.rb

@@ -14,21 +14,15 @@ module Ruboty
       )
 
       on(
-        /punch the clock\z/,
-        description: "Punch the clock on JOBCAN",
-        name: "punch_clock",
+        /register my jobcan group alias (?<group_name>.+?) -> (?<group_id>\d+)\z/,
+        description: "Create alias to JOBCAN group ID",
+        name: "register_group_alias",
       )
 
       on(
-        /clock in\z/,
-        description: "Clock in on JOBCAN",
-        name: "clock_in",
-      )
-
-      on(
-        /clock out\z/,
-        description: "Clock out on JOBCAN",
-        name: "clock_out",
+        /clock (?<in_out>in|out)(?: at (?<group_name>.+))?\z/,
+        description: "Clock in/out on JOBCAN (at group)",
+        name: "clock_in_out",
       )
 
       def remember_code(message)
@@ -39,16 +33,12 @@ module Ruboty
         Ruboty::Actions::Jobcan.new(message).remember_group_id
       end
 
-      def punch_clock(message)
-        Ruboty::Actions::Jobcan.new(message).punch_clock
-      end
-
-      def clock_in(message)
-        Ruboty::Actions::Jobcan.new(message).clock_in
+      def register_group_alias(message)
+        Ruboty::Actions::Jobcan.new(message).register_group_alias
       end
 
-      def clock_out(message)
-        Ruboty::Actions::Jobcan.new(message).clock_out
+      def clock_in_out(message)
+        Ruboty::Actions::Jobcan.new(message).clock_in_out
       end
     end
   end

data/lib/ruboty/jobcan/version.rb

@@ -1,5 +1,5 @@
 module Ruboty
   module Jobcan
-    VERSION = "0.1.1"
+    VERSION = "0.2.0"
   end
 end

data/ruboty-jobcan.gemspec

@@ -21,7 +21,8 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "bundler", "~> 1.10"
   spec.add_development_dependency "rake", "~> 10.0"
 
-  spec.add_runtime_dependency "faraday", "~> 0.9.0"
-  spec.add_runtime_dependency "faraday_middleware", "~> 0.10.0"
-  spec.add_runtime_dependency "faraday-cookie_jar", "~> 0.0.6"
+  spec.add_runtime_dependency "faraday", "~> 0.9"
+  spec.add_runtime_dependency "faraday_middleware", "~> 0.10"
+  spec.add_runtime_dependency "faraday-cookie_jar", "~> 0.0"
+  spec.add_runtime_dependency "jbcn", "~> 0.1"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ruboty-jobcan
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0
 platform: ruby
 authors:
 - Tomoki Aonuma
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2015-11-25 00:00:00.000000000 Z
+date: 2016-12-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -44,42 +44,56 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.9.0
+        version: '0.9'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.9.0
+        version: '0.9'
 - !ruby/object:Gem::Dependency
   name: faraday_middleware
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.10.0
+        version: '0.10'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.10.0
+        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
+        version: '0.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.0.6
+        version: '0.0'
+- !ruby/object:Gem::Dependency
+  name: jbcn
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
 description: Ruboty plug-in for punching the clock on JOBCAN.
 email:
 - uasi@uasi.jp
@@ -94,6 +108,7 @@ files:
 - Rakefile
 - bin/console
 - bin/setup
+- img/group_id.png
 - lib/ruboty/actions/jobcan.rb
 - lib/ruboty/handlers/jobcan.rb
 - lib/ruboty/jobcan.rb
@@ -118,7 +133,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5.1
+rubygems_version: 2.6.8
 signing_key: 
 specification_version: 4
 summary: Ruboty plug-in for punching the clock on JOBCAN.