by_robot 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 4472816e99db7354a63e611bf1cec1e1acef05d72e9eac914cd9165728377f5c
+  data.tar.gz: ff399cfe0aa3ca17fc1b3dd65ee222cd2fbb92f2b0c37b7a611c2489b72de243
+SHA512:
+  metadata.gz: bc5240c67c40be1a4af21fa9eddd00ed5b79c6e0c9c7319b40e23a0795eab5a67c3623d73ceb5a0572a8788916f40c5d5ea13fd6f9e311e60a33187bf36d0542
+  data.tar.gz: 4598cfdc598d93ed1c462cb4417f05406a8f14f47341e118bd3091c7322dad1a50c9cc093986cdf5315248dd58700b217037621b25fcddc1dac61d42ef4e0d49

data/.gitignore

@@ -0,0 +1,20 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+.idea
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+.ruby-version
+.ruby-gemset

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--require spec_helper

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at liuliang0817@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://gems.ruby-china.com'
+
+# Specify your gem's dependencies in by_robot.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 liuliang
+
+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,76 @@
+# BYAI
+
+ByRobot/BYAI Server SDK in Ruby.
+
+## API文档
+- 官方文档(https://api.byrobot.cn/doc/v2)
+- 官方网站(https://www.byai.com)
+
+## API接口
+
+### Company
+- get_companys 获取绑定公司列表接口
+- get_phones 获取公司的主叫电话列表接口
+- get_robots 获取公司的机器人话术列表接口
+
+### Task
+- create_task 创建任务接口
+- start 启动任务接口
+- pause 暂停任务接口
+- stop 停止任务接口
+- delete 删除任务
+- import_task_customer 向任务中导入客户接口
+- update 修改任务
+- call 单次电话外呼
+- single_call_by_mobile 根据手机号进行单次电话外呼
+- get_tasks 获取任务列表接口
+- get_task_detail 获取任务详情接口
+- query_done_task_phones 获取已经完成任务电话号码接口
+- not_dialed_customer_list 获取任务未开始的电话列表
+- phone_log_info 获取一个通话的详情接口
+
+### 例子
+```ruby
+
+ByRobot.app_key = "abc"
+ByRobot.app_secret = "abc"
+ByRobot::Company.get_companys
+ByRobot::Task.get_tasks(companyId: 111)
+
+```
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'by_robot'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install by_robot
+
+## Usage
+
+TODO: Write usage instructions here
+
+## 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/liuliang/by_robot. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+
+## 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,5 @@
+require "bundler/gem_tasks"
+task :default => :spec
+task :console do
+  exec "irb -r by_robot -I ./lib"
+end

data/bin/console

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

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'by_robot/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "by_robot"
+  spec.version       = ByRobot::VERSION
+  spec.authors       = ["liuliang"]
+  spec.email         = ["liuliang0817@gmail.com"]
+
+  spec.summary       = %q{百应/BYAI的服务端接口.}
+  spec.description   = %q{百应/BYAI的服务端接口.}
+  spec.homepage      = "https://github.com/liuliang/by_robot"
+  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_development_dependency "rspec", "~> 3.4"
+  spec.add_development_dependency "rest-client", "~> 1.8"
+end

data/lib/by_robot/company.rb

@@ -0,0 +1,20 @@
+# encoding: utf-8
+module ByRobot
+  class Company
+    
+    def self.get_companys(params={})
+      Request.get('/openapi/v1/company/getCompanys', params)
+    end
+    
+    def self.get_phones(params={})
+      Request.check_required_params(params, %w(companyId))
+      Request.get('openapi/v1/company/getPhones', params)
+    end
+    
+    def self.get_robots(params={})
+      Request.check_required_params(params, %w(companyId))
+      Request.get('openapi/v1/company/getRobots', params)
+    end
+    
+  end
+end

data/lib/by_robot/request.rb

@@ -0,0 +1,38 @@
+module ByRobot
+  class Request
+    
+    BASEURL = "http://api.byrobot.cn"
+    
+    def self.check_required_params(params, names)
+      missing_params = names.map(&:to_s) - params.keys.map(&:to_s)
+      warn("Warn: missing required option: #{missing_params.join(',')}") if missing_params.size > 0
+    end
+
+    def self.sign(sign_message)
+      digest = OpenSSL::Digest.new('sha1')
+      sign = Base64.encode64 OpenSSL::HMAC.digest(digest, ByRobot.app_secret, sign_message)
+    end
+
+    def self.headers
+      headers = {
+        datetime: Time.now.utc.strftime('%a, %d %b %Y %H:%M:%S GMT'), 
+        appkey: ByRobot.app_key
+      }
+      str = headers[:appkey] + "\n" + headers[:datetime]
+      headers[:sign] = sign(str)
+      headers
+    end
+
+    def self.get(action, params)
+      JSON.parse RestClient.get("#{BASEURL}/#{action}", headers.merge({params: params}))
+    end
+
+    def self.post(action, params)
+      puts "action:#{action}"
+      puts "params:#{params}"
+      puts "headers:#{headers}"
+      JSON.parse RestClient.post("#{BASEURL}/#{action}", params, headers)
+    end
+
+  end
+end

data/lib/by_robot/task.rb

@@ -0,0 +1,76 @@
+# encoding: utf-8
+module ByRobot
+  class Task
+    
+    def self.create_task(params={})
+      Request.check_required_params(params, %w(companyId taskName taskType startDate userPhoneIds sceneDefId robotDefId sceneRecordId callType))
+      Request.post('/openapi/v1/task/createTask', params)
+    end
+    
+    def self.start(params={})
+      Request.check_required_params(params, %w(taskId))
+      Request.post('openapi/v1/task/start', params)
+    end
+    
+    def self.pause(params={})
+      Request.check_required_params(params, %w(taskId))
+      Request.post('openapi/v1/task/pause', params)
+    end
+    
+    def self.stop(params={})
+      Request.check_required_params(params, %w(taskId))
+      Request.post('openapi/v1/task/stop', params)
+    end
+    
+    def self.delete(params={})
+      Request.check_required_params(params, %w(taskId))
+      Request.post('openapi/v1/task/delete', params)
+    end
+    
+    def self.import_task_customer(params={})
+      Request.check_required_params(params, %w(companyId taskId customerInfoList))
+      Request.post('openapi/v1/task/importTaskCustomer', params)
+    end
+    
+    def self.update(params={})
+      Request.check_required_params(params, %w(companyId taskId taskName taskType userPhoneIds callType concurrencyQuota))
+      Request.post('openapi/v1/task/update', params)
+    end
+    
+    def self.call(params={})
+      Request.check_required_params(params, %w(customerId mobile companyId sceneDefId sceneRecordId robotDefId))
+      Request.post('openapi/v1/task/call', params)
+    end
+    
+    def self.single_call_by_mobile(params={})
+      Request.check_required_params(params, %w(mobile companyId sceneDefId sceneRecordId robotDefId))
+      Request.post('openapi/v1/task/singleCallByMobile', params)
+    end
+    
+    def self.get_tasks(params={})
+      Request.check_required_params(params, %w(companyId))
+      Request.get('openapi/v1/task/getTasks', params)
+    end
+    
+    def self.get_task_detail(params={})
+      Request.check_required_params(params, %w(companyId taskId))
+      Request.get('openapi/v1/task/getTaskDetail', params)
+    end
+    
+    def self.query_done_task_phones(params={})
+      Request.check_required_params(params, %w(callJobId))
+      Request.post('openapi/v1/task/queryDoneTaskPhones', params)
+    end
+    
+    def self.not_dialed_customer_list(params={})
+      Request.check_required_params(params, %w(taskId))
+      Request.post('openapi/v1/task/notDialedCustomerList', params)
+    end
+    
+    def self.phone_log_info(params={})
+      Request.check_required_params(params, %w(callInstanceId))
+      Request.get('openapi/v1/task/phoneLogInfo', params)
+    end
+    
+  end
+end

data/lib/by_robot/version.rb

@@ -0,0 +1,3 @@
+module ByRobot
+  VERSION = "0.0.1"
+end

data/lib/by_robot.rb

@@ -0,0 +1,11 @@
+require 'rest-client'
+require 'digest/sha1'
+require "by_robot/version"
+require 'by_robot/request'
+require 'by_robot/company'
+require 'by_robot/task'
+module ByRobot
+  class << self
+    attr_accessor :app_key, :app_secret
+  end
+end

metadata

@@ -0,0 +1,115 @@
+--- !ruby/object:Gem::Specification
+name: by_robot
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- liuliang
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-01-21 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: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+- !ruby/object:Gem::Dependency
+  name: rest-client
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+description: 百应/BYAI的服务端接口.
+email:
+- liuliang0817@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- by_robot.gemspec
+- lib/by_robot.rb
+- lib/by_robot/company.rb
+- lib/by_robot/request.rb
+- lib/by_robot/task.rb
+- lib/by_robot/version.rb
+homepage: https://github.com/liuliang/by_robot
+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.7.7
+signing_key: 
+specification_version: 4
+summary: 百应/BYAI的服务端接口.
+test_files: []