kf5_api 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: b708b594217b9359f7b2d71c608a83e2878dd664
+  data.tar.gz: d96838ce2f1dd81edf633bfff8715b8d4fd6c0bf
+SHA512:
+  metadata.gz: ff285f2348fc97a2473e96e87a3e0cdb1c14eb02f171f1cd5a2c72d165af96d09e51fda0b67b28bdfa503b5d4e2503e761d632b260095bbc117ed1de969e3b47
+  data.tar.gz: e0506cab5029338cea576883ba4d69930dc8570d548793d046166c6bf712e44102faeb0dc17e5ecc57a67473e0b19d21d3959647fdd967ab258a8e25f0abbaca

data/.gitignore

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

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.4.0
+before_install: gem install bundler -v 1.14.5

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 402399938@qq.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://rubygems.org'
+
+# Specify your gem's dependencies in kf5_api.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 wangrui
+
+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,41 @@
+# Kf5Api
+
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/kf5_api`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+TODO: Delete this and the text above, and describe your gem
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'kf5_api'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install kf5_api
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. 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/[USERNAME]/kf5_api. 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,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

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

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

@@ -0,0 +1,38 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'kf5_api/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "kf5_api"
+  spec.version       = Kf5Api::VERSION
+  spec.authors       = ["wangrui"]
+  spec.email         = ["wangr0620@gmail.com"]
+
+  spec.summary       = %q{逸创云客服RESTful API for ruby}
+  spec.description   = %q{逸创云客服RESTful API for ruby，目前只实现了需要的接口}
+  spec.homepage      = "https://github.com/wangrui438/kf5_api"
+  spec.license       = "MIT"
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  if spec.respond_to?(:metadata)
+    spec.metadata['allowed_push_host'] = "https://rubygems.org/"
+  else
+    raise "RubyGems 2.0 or newer is required to protect against " \
+      "public gem pushes."
+  end
+
+  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.14"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+
+  spec.add_dependency 'httparty'
+end

data/lib/kf5_api/base.rb

@@ -0,0 +1,18 @@
+require 'httparty'
+
+module Kf5Api
+  module Base
+    def get(action, query_params = {})
+      server = "https://#{Kf5Api.config.sub_domain}.kf5.com"
+      query_params = query_params.inject({}){ |memo, (k,v)| memo[k.to_s] = v; memo }
+
+      HTTParty.get(server + action, query: query_params, basic_auth: basic_auth, header: { 'Content-Type' => 'application/json' })
+    end
+
+    def basic_auth(user_name = nil, password = nil, use_password = false)
+      user_name ||= use_password ? Kf5Api.config.user_name : "#{Kf5Api.config.user_name}/token"
+      password ||= use_password ? Kf5Api.config.password : Kf5Api.config.token
+      { username: user_name, password: password }
+    end
+  end
+end

data/lib/kf5_api/configuration.rb

@@ -0,0 +1,5 @@
+module Kf5Api
+  class Configuration
+    attr_accessor :sub_domain, :user_name, :password, :token
+  end
+end

data/lib/kf5_api/kchat.rb

@@ -0,0 +1,24 @@
+module Kf5Api
+  class Kchat
+    extend Kf5Api::Base
+    private_class_method :new
+    # http://developer.kf5.com/restfulapi/kchat/history
+
+    ACTIONS_HASH = {
+      history: '/apiv2/kchat/history',
+      chat: '/apiv2/kchat/history/%{id}'
+    }
+
+    class << self
+      # 对话列表
+      def history(query_params = {})
+        get(ACTIONS_HASH[:history], query_params).parsed_response['chats']
+      end
+
+      # 查看对话
+      def chat(chat_id)
+        get(format(ACTIONS_HASH[:chat], id: chat_id)).parsed_response['chat']
+      end
+    end
+  end
+end

data/lib/kf5_api/organization.rb

@@ -0,0 +1,17 @@
+module Kf5Api
+  class Organization
+    extend Kf5Api::Base
+    private_class_method :new
+    # http://developer.kf5.com/restfulapi/core/organizations
+
+    ACTIONS_HASH = {
+      all: '/apiv2/organizations'
+    }
+
+    class << self
+      def all(query_params = {})
+        get(ACTIONS_HASH[:all], query_params).parsed_response['organizations']
+      end
+    end
+  end
+end

data/lib/kf5_api/user.rb

@@ -0,0 +1,19 @@
+module Kf5Api
+  class User
+    extend Kf5Api::Base
+    private_class_method :new
+    # http://developer.kf5.com/restfulapi/core/users
+
+    ACTIONS_HASH = {
+      users_by_org: '/apiv2/organizations/%{id}/users'
+    }
+
+    class << self
+      # 获取某个组织下的所有用户
+      def users_by_organization(org_id, query_params = {})
+        action = format(ACTIONS_HASH[:users_by_org], id: org_id)
+        get(action, query_params).parsed_response['users']
+      end
+    end
+  end
+end

data/lib/kf5_api/version.rb

@@ -0,0 +1,3 @@
+module Kf5Api
+  VERSION = "0.1.0"
+end

data/lib/kf5_api.rb

@@ -0,0 +1,18 @@
+require "kf5_api/version"
+require "kf5_api/configuration"
+require "kf5_api/base"
+require "kf5_api/organization"
+require "kf5_api/user"
+require "kf5_api/kchat"
+
+module Kf5Api
+  class << self
+    def setup
+      yield config
+    end
+
+    def config
+      @config ||= Configuration.new
+    end
+  end
+end

metadata

@@ -0,0 +1,119 @@
+--- !ruby/object:Gem::Specification
+name: kf5_api
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- wangrui
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-06-13 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+- !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.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: 逸创云客服RESTful API for ruby，目前只实现了需要的接口
+email:
+- wangr0620@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- kf5_api.gemspec
+- lib/kf5_api.rb
+- lib/kf5_api/base.rb
+- lib/kf5_api/configuration.rb
+- lib/kf5_api/kchat.rb
+- lib/kf5_api/organization.rb
+- lib/kf5_api/user.rb
+- lib/kf5_api/version.rb
+homepage: https://github.com/wangrui438/kf5_api
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org/
+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.10
+signing_key: 
+specification_version: 4
+summary: 逸创云客服RESTful API for ruby
+test_files: []