docomo-nlu 0.1.3 → 0.2.0

data/lib/docomo-nlu/management/V26/aiml_base.rb

@@ -0,0 +1,199 @@
+# frozen_string_literal: true
+
+# download([:aiml,:dat,:archive],scenarioId)
+# GET /{projectId}/bots/{botId}/aiml/{scenarioId}
+# GET /{projectId}/bots/{botId}/dat
+# GET /{projectId}/bots/{botId}/archive
+
+# upload([:aiml,:dat,:archive],filepath)
+# /{projectId}/bots/{botId}/aiml
+# /{projectId}/bots/{botId}/dat
+# /{projectId}/bots/{botId}/archive
+
+# Not supported
+# GET /{projectId}/bots/{botId}/archive/aiml
+
+# require 'rubyzip'
+
+require "tempfile"
+module DocomoNlu
+  module Management::V26
+    class AIMLBase < Base
+      ## For AIML
+
+      def download(extra_path = "")
+        prefix_options[:bot_id] ||= botId
+        @attributes[:file] = self.class.download(prefix_options, extra_path).file
+      end
+
+      def upload(file, type = :aiml)
+        prefix_options[:bot_id] ||= botId
+        prefix_options[:method] ||= type
+        self.class.upload(file, prefix_options)
+      end
+
+      def compile
+        prefix_options[:bot_id] ||= botId
+        self.class.compile(prefix_options)
+      end
+
+      def transfer
+        prefix_options[:bot_id] ||= botId
+        self.class.deploy_request(prefix_options)
+      end
+
+      def deploy
+        prefix_options[:bot_id] ||= botId
+        self.class.deploy(prefix_options)
+      end
+
+      ## For FAQ
+
+      def upload_userdic(file)
+        prefix_options[:bot_id] ||= botId
+        prefix_options[:method] = "userDic"
+        self.class.upload(file, prefix_options)
+      end
+
+      def upload_stopkey(file)
+        prefix_options[:bot_id] ||= botId
+        prefix_options[:method] = "stopkey"
+        self.class.upload(file, prefix_options)
+      end
+
+      def download_stopkey
+        prefix_options[:bot_id] ||= botId
+        prefix_options[:method] = "stopkey"
+        @attributes[:stopkey] = self.class.download(prefix_options).file
+      end
+
+      def upload_truthlist(file)
+        prefix_options[:bot_id] ||= botId
+        prefix_options[:method] = "truthlist"
+        self.class.upload(file, prefix_options)
+      end
+
+      def download_truthlist
+        prefix_options[:bot_id] ||= botId
+        prefix_options[:method] = "truthlist"
+        @attributes[:truthlist] = self.class.download(prefix_options).file
+      end
+
+      def upload_entry(file)
+        prefix_options[:bot_id] ||= botId
+        prefix_options[:method] = "entry"
+        self.class.upload(file, prefix_options)
+      end
+
+      def check_faq_status(method)
+        prefix_options[:bot_id] ||= botId
+        prefix_options[:method] = method
+        self.class.check_status(:faq, "#{FileModel.collection_path(prefix_options)}/status")
+      end
+
+      class << self
+        def download(prefix_options, extra_path = "")
+          conn = Faraday.new(url: site.to_s, ssl: { verify: false }) do |builder|
+            builder.adapter :net_http
+          end
+          conn.headers["Authorization"] = access_token
+          response = conn.get("#{FileModel.collection_path(prefix_options)}/#{extra_path}")
+
+          if check_response(response)
+            instantiate_record({}, prefix_options).tap do |record|
+              record.file = Tempfile.open(["docomo-nlu", ".#{prefix_options[:method]}"]) do |f|
+                f.write response.body.force_encoding("UTF-8")
+                f
+              end
+            end
+          end
+        end
+
+        def upload(file, prefix_options)
+          conn = Faraday.new(url: site.to_s, ssl: { verify: false }) do |builder|
+            builder.request :multipart # マルチパートでデータを送信
+            builder.request :url_encoded
+            builder.adapter :net_http
+          end
+          conn.headers["Authorization"] = access_token
+          params = {
+            uploadFile: Faraday::UploadIO.new(file.path, "text/plain"),
+          }
+          response = conn.put FileModel.collection_path(prefix_options), params
+          check_response(response)
+        end
+
+        def compile(prefix_options)
+          return if deploy_request(:compile, prefix_options)  != ""
+        end
+
+        def transfer(prefix_options)
+          return if deploy_request(:transfer, prefix_options) != ""
+        end
+
+        def deploy_request(method, prefix_options)
+          response_body = JSON.parse(connection.post(Scenario.element_path(method, prefix_options), "", headers).body)
+          # Sometimes, API returns wrong url, replace correct path.
+          URI.parse(response_body["statusUri"]).path.gsub!(/NLPManagementAPI/, "management/v2.6")
+        end
+
+        def deploy(prefix_options)
+          # compile and status check
+          compile_status = false
+          check_path = deploy_request(:compile, prefix_options)
+          while check_path && compile_status != "Completed"
+            sleep(0.2)
+            compile_status = check_status(:compile, check_path)
+            raise ActiveResource::ServerError if %w[ErrorFinish NotCompiled].include?(compile_status)
+          end
+
+          # transfer and status check
+          transfer_status = false
+          check_path = deploy_request(:transfer, prefix_options)
+          while check_path && transfer_status != "Completed"
+            sleep(0.2)
+            transfer_status = check_status(:transfer, check_path)
+            raise ActiveResource::ServerError if %w[ErrorFinish NotTransfered].include?(transfer_status)
+          end
+          true
+        end
+
+        def check_status(method, path)
+          case method
+          when :compile, :faq then JSON.parse(connection.get(path, headers).body)["status"]
+          when :transfer      then JSON.parse(connection.get(path, headers).body)["transferStatusResponses"][0]["status"]
+          end
+        end
+
+        # def generate_file(response, method)
+        #   case method
+        #   when :aiml, :dat then
+        #     Tempfile.open(["docomo-nlu", ".#{prefix_options[:method].to_s}"]) do |f|
+        #       f.write response.body.force_encoding("UTF-8")
+        #       f
+        #     end
+        #   when :zip then
+        #     zip_file = Tempfile.new(["docomo-nlu", ".#{prefix_options[:method].to_s.gsub(/archive/, "zip")}"])
+        #     Zip::OutputStream.open(zip_file.path) do |zip|
+        #       @targets.each do |target|
+        #         zip.put_next_entry("#{target.filename}.pdf")
+        #         zip.print Net::HTTP.get URI.parse(target.url)
+        #       end
+        #     end
+        #     Zip::File.open_buffer(file.read) do |zf|
+        #       zf.each do |entry|
+        #         p entry.name # ファイル名
+        #         p entry.get_input_stream.read # ファイルの中身
+        #       end
+        #     end
+        #   end
+        # end
+      end
+
+      class FileModel < Base
+        self.element_name = ""
+        self.prefix = "/management/v2.6/projects/:project_id/bots/:bot_id/:method"
+      end
+    end
+  end
+end

data/lib/docomo-nlu/management/V26/base.rb

@@ -0,0 +1,88 @@
+# frozen_string_literal: true
+
+require "net/http"
+
+module DocomoNlu
+  module Management::V26
+    class Base < ActiveResource::Base
+      ## For Dynamically generated headers via http://rmosolgo.github.io/blog/2014/02/05/dynamically-generated-headers-for-activeresource-requests/
+      cattr_accessor :static_headers
+      cattr_accessor :access_token
+
+      ## Dynamic headers
+      self.static_headers = headers
+
+      ## Admin Accesstoken
+      self.access_token = DocomoNlu.config.admin_access_token
+
+      ## Setting Endpoint.
+      self.site = DocomoNlu.config.nlu_host
+
+      ## Remove format in path (remove .json)
+      self.include_format_in_path = false
+
+      self.format = :json
+
+      ## Get NLPManagement's AccessToken.
+      def login(accountName, password)
+        request_body = { accountName: accountName, password: password }.to_json
+        response_body = JSON.parse(connection.post("/management/v2.6/login", request_body, self.class.headers).body)
+        self.access_token = response_body["accessToken"]
+      end
+
+      ## Delete NLPManagement's AccessToken.
+      def logout
+        res = connection.get("/management/v2.6/logout", self.class.headers) if access_token.present?
+        raise ActiveResource::BadRequest, "Invalid access token" unless res
+
+        self.access_token = nil
+        true
+      end
+
+      ## Override. Insert generated id to parameter 'id' after save or create
+      def id_from_response(response)
+        ActiveSupport::JSON.decode(response.body)["#{self.class.to_s.split("::").last.downcase!}Id"] if response.body.present?
+      end
+
+      class << self
+        def instantiate_collection(collection, original_params = {}, prefix_options = {})
+          if collection.is_a?(Hash)
+            collection = if collection.empty? || collection.first[1].nil?
+                           []
+                         else
+                           [collection]
+                         end
+          elsif collection[0].is_a?(String)
+            collection = [{ params: collection }]
+          end
+          super
+        end
+
+        def instantiate_record(record, prefix_options = {})
+          record = record[0] if record.is_a?(Array)
+          resource_id = record["#{to_s.split("::").last.downcase!}Id"]
+          record["id"] = resource_id if resource_id
+          super
+        end
+
+        def headers
+          new_headers = static_headers.clone
+          new_headers["Authorization"] = access_token
+          new_headers
+        end
+
+        def check_response(response)
+          case response.status
+          when 400       then raise ActiveResource::BadRequest, response
+          when 401       then raise ActiveResource::UnauthorizedAccess, response
+          when 403       then raise ActiveResource::ForbiddenAccess, response
+          when 404       then raise ActiveResource::ResourceNotFound, response
+          when 409       then raise ActiveResource::ResourceConflict, response
+          when 503       then raise ActiveResource::ServerError, response
+          when 200..204  then true
+          end
+        end
+      end
+    end
+  end
+end

data/lib/docomo-nlu/management/V26/bot.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module DocomoNlu
+  module Management::V26
+    class Bot < AIMLBase
+      self.element_name = "bots"
+      self.prefix = "/management/v2.6/projects/:project_id/"
+
+      # Parameter for create
+      # {
+      #   "botId": "botid",
+      #   "scenarioProjectId", "DSU",
+      #   "language": "ja-JP",
+      #   "description": "hello"
+      # }
+    end
+  end
+end

data/lib/docomo-nlu/management/V26/config.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module DocomoNlu
+  module Management::V26
+    class Config < Base
+      self.element_name = "configs"
+      self.prefix = "/management/v2.6/projects/:project_id/bots/:bot_id/"
+
+      # {
+      #   "dialogTimeout": 300,
+      #   "replyTimeout": 300,
+      #   "xxxxUrl": "http://xxx",
+      #   "yyyyUrl": "http://xxx",
+      #   "sensitiveInfo": "aa.bb, ccc.ddd...",
+      #   "sraix" : [true|false],
+      #   "taskServerUrl": "http://xxx"
+      # }
+
+      def destroy(keys)
+        self.id = keys.join(",")
+        super()
+      end
+    end
+  end
+end

data/lib/docomo-nlu/management/V26/default_predicate.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module DocomoNlu
+  module Management::V26
+    class DefaultPredicate < Base
+      self.element_name = "defaultPredicates"
+      self.prefix = "/management/v2.6/projects/:project_id/bots/:bot_id/"
+
+      def destroy(keys)
+        self.id = keys.join(",")
+        super()
+      end
+    end
+  end
+end

data/lib/docomo-nlu/management/V26/map.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+module DocomoNlu
+  module Management::V26
+    class Map < MultipartBase
+      self.element_name = "maps"
+      self.prefix = "/management/v2.6/projects/:project_id/bots/:bot_id/"
+    end
+  end
+end

data/lib/docomo-nlu/management/V26/multipart_base.rb

@@ -0,0 +1,83 @@
+# frozen_string_literal: true
+
+require "tempfile"
+module DocomoNlu
+  module Management::V26
+    class MultipartBase < Base
+      def save
+        self.class.create(attributes[:file], prefix_options)
+      end
+
+      def destroy
+        self.id = try(:category)
+        super
+      end
+
+      class << self
+        def create(file, prefix_options)
+          check_prefix_options(prefix_options)
+          raise ActiveResource::BadRequest, "" unless file.instance_of?(File)
+
+          upload(file, prefix_options)
+        end
+
+        def find(*arguments)
+          scope   = arguments.slice!(0)
+          options = arguments.slice!(0) || {}
+
+          prefix_options, = split_options(options[:params])
+          check_prefix_options(prefix_options)
+
+          case scope
+          when :all then download(nil, prefix_options)
+          else download(scope, prefix_options)
+          end
+        end
+
+        def where(clauses = {})
+          raise ArgumentError, "expected a clauses Hash, got #{clauses.inspect}" unless clauses.is_a? Hash
+
+          category = clauses[:category]
+          find(category, params: clauses)
+        end
+
+        private
+
+        def download(category = nil, prefix_options)
+          extention = category.blank? ? ".zip" : ".map"
+
+          conn = Faraday.new(url: site.to_s, ssl: { verify: false }) do |builder|
+            builder.adapter :net_http
+          end
+          conn.headers["Authorization"] = access_token
+
+          response = conn.get(element_path(category, prefix_options))
+
+          if check_response(response)
+            instantiate_record({}, prefix_options).tap do |record|
+              record.file = Tempfile.open(["docomo-nlu", extention]) do |f|
+                f.write response.body.force_encoding("UTF-8")
+                f
+              end
+              record.category = category
+            end
+          end
+        end
+
+        def upload(file, prefix_options)
+          conn = Faraday.new(url: site.to_s, ssl: { verify: false }) do |builder|
+            builder.request :multipart # マルチパートでデータを送信
+            builder.request :url_encoded
+            builder.adapter :net_http
+          end
+          conn.headers["Authorization"] = access_token
+          params = {
+            uploadFile: Faraday::UploadIO.new(file.path, "text/plain"),
+          }
+          response = conn.put collection_path(prefix_options), params
+          check_response(response)
+        end
+      end
+    end
+  end
+end

data/lib/docomo-nlu/management/V26/ng_word.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+module DocomoNlu
+  module Management::V26
+    class NGWord < Base
+      self.element_name = "ngWords"
+      self.prefix = "/management/v2.6/projects/:project_id/bots/:bot_id/"
+    end
+  end
+end

data/lib/docomo-nlu/management/V26/ok_word.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+module DocomoNlu
+  module Management::V26
+    class OKWord < Base
+      self.element_name = "okWords"
+      self.prefix = "/management/v2.6/projects/:project_id/bots/:bot_id/"
+    end
+  end
+end

data/lib/docomo-nlu/management/V26/organization.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module DocomoNlu
+  module Management::V26
+    class Organization < Base
+      self.element_name = "organizations"
+      self.prefix = "/management/v2.6/"
+
+      # Parameter create
+      # {
+      #    "organizationName": "your organization name",
+      #    "address": "address",
+      #    "tel": "tel"
+      # }
+
+      def to_json(options = {})
+        attributes.delete("organizationId")
+        attributes.delete("id")
+        super
+      end
+    end
+  end
+end

data/lib/docomo-nlu/management/V26/organization_member.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module DocomoNlu
+  module Management::V26
+    class OrganizationMember < Base
+      self.element_name = "members"
+      self.prefix = "/management/v2.6/organizations/:organization_id/"
+
+      def destroy
+        self.id = accountId
+        super
+      end
+    end
+  end
+end

data/lib/docomo-nlu/management/V26/predicate_name.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module DocomoNlu
+  module Management::V26
+    class PredicateName < Base
+      self.element_name = "predicateNames"
+      self.prefix = "/management/v2.6/projects/:project_id/bots/:bot_id/"
+
+      def destroy(keys)
+        self.id = keys.join(",")
+        super()
+      end
+    end
+  end
+end

data/lib/docomo-nlu/management/V26/project.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module DocomoNlu
+  module Management::V26
+    class Project < Base
+      self.element_name = "projects"
+      self.prefix = "/management/v2.6/"
+
+      # Parameter for create
+      # {
+      #   "projectName": "your project name"
+      #   "organizationId": "your organization id"
+      # }
+    end
+  end
+end

data/lib/docomo-nlu/management/V26/project_member.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module DocomoNlu
+  module Management::V26
+    class ProjectMember < Base
+      self.element_name = "members"
+      self.prefix = "/management/v2.6/projects/:project_id/"
+
+      def destroy
+        self.id = accountId
+        super
+      end
+    end
+  end
+end

data/lib/docomo-nlu/management/V26/property.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+module DocomoNlu
+  module Management::V26
+    class Property < Base
+      self.element_name = "properties"
+      self.prefix = "/management/v2.6/projects/:project_id/bots/:bot_id/"
+    end
+  end
+end

data/lib/docomo-nlu/management/V26/provider.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module DocomoNlu
+  module Management::V26
+    class Provider < Base
+      self.element_name = "providers"
+      self.prefix = "/management/v2.6/"
+
+      # Parameter for create
+      # {
+      #   "organizationId": "id",
+      #   "serverKind":"SS",
+      #   "serverId":  "DSU"
+      # }
+    end
+  end
+end

data/lib/docomo-nlu/management/V26/scenario.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+module DocomoNlu
+  module Management::V26
+    class Scenario < AIMLBase
+      self.element_name = "scenarios"
+      self.prefix = "/management/v2.6/projects/:project_id/bots/:bot_id/"
+
+      @permitted_root_param = [:userScenarios, :templateScenarios]
+      @permitted_userScenarios_param = [:scenarioId, :description, :compileFlag]
+
+      def save
+        @attributes.select! {|a| a =~ /(userScenarios|templateScenarios)/ }
+        userScenarios.each do |us|
+          us.attributes.select! {|a| a =~ /(scenarioId|description|compileFlag)/ }
+        end
+        super
+      end
+
+      def destroy(scenario_id)
+        self.id = scenario_id
+        super()
+      end
+
+      class UserScenarios < Base; end
+      class TemplateScenarios < Base; end
+    end
+  end
+end

data/lib/docomo-nlu/management/V26/scenario_project.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+module DocomoNlu
+  module Management::V26
+    class ScenarioProject < Base
+      self.element_name = "scenarioProjects"
+      self.prefix = "/management/v2.6/"
+    end
+  end
+end

data/lib/docomo-nlu/management/V26/scenario_util.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+module DocomoNlu
+  module Management::V26
+    class ScenarioUtil < Base
+      self.element_name = "scenarioUtils"
+      self.prefix = "/management/v2.6/"
+
+      def normalize
+        # TODO
+      end
+
+      def matches
+        # TODO
+      end
+
+      def save
+        print "Method not used"
+      end
+
+      def destroy
+        print "Method not used"
+      end
+
+      def delete
+        print "Method not used"
+      end
+    end
+  end
+end

data/lib/docomo-nlu/management/V26/set.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+module DocomoNlu
+  module Management::V26
+    class Set < MultipartBase
+      self.element_name = "sets"
+      self.prefix = "/management/v2.6/projects/:project_id/bots/:bot_id/"
+    end
+  end
+end