upkey-chatterly-client 1.0.0

Sign up to get free protection for your applications and to get access to all the features.
checksums.yaml ADDED
@@ -0,0 +1,7 @@
1
+ ---
2
+ SHA1:
3
+ metadata.gz: dc08f565050dbf4564c8bf2ce9e701382576b0ef
4
+ data.tar.gz: 802d47cadc5eed2285d420f8395742b0e3f73ff6
5
+ SHA512:
6
+ metadata.gz: 8c875820c10922057843da08dd3aeaad16efe260847b57c32377e3df46842532b3cbcf742e236715ad8046ff99386cca95ebc9b517514486c1e9310c97832f03
7
+ data.tar.gz: f00e95fe4dc7796edc686a81691b751465b672ec411d957566b9c4d7106dbcbbe56480c3c0f5144214aeeebcb2d8a93699f4a59433daad1a0087ffd1b056134f
data/.gitignore ADDED
@@ -0,0 +1,12 @@
1
+ /.bundle/
2
+ /.yardoc
3
+ /Gemfile.lock
4
+ /_yardoc/
5
+ /coverage/
6
+ /doc/
7
+ /pkg/
8
+ /spec/reports/
9
+ /tmp/
10
+
11
+ # rspec failure tracking
12
+ .rspec_status
data/.rspec ADDED
@@ -0,0 +1,2 @@
1
+ --format documentation
2
+ --color
data/.travis.yml ADDED
@@ -0,0 +1,5 @@
1
+ sudo: false
2
+ language: ruby
3
+ rvm:
4
+ - 2.2.4
5
+ before_install: gem install bundler -v 1.15.3
@@ -0,0 +1,74 @@
1
+ # Contributor Covenant Code of Conduct
2
+
3
+ ## Our Pledge
4
+
5
+ In the interest of fostering an open and welcoming environment, we as
6
+ contributors and maintainers pledge to making participation in our project and
7
+ our community a harassment-free experience for everyone, regardless of age, body
8
+ size, disability, ethnicity, gender identity and expression, level of experience,
9
+ nationality, personal appearance, race, religion, or sexual identity and
10
+ orientation.
11
+
12
+ ## Our Standards
13
+
14
+ Examples of behavior that contributes to creating a positive environment
15
+ include:
16
+
17
+ * Using welcoming and inclusive language
18
+ * Being respectful of differing viewpoints and experiences
19
+ * Gracefully accepting constructive criticism
20
+ * Focusing on what is best for the community
21
+ * Showing empathy towards other community members
22
+
23
+ Examples of unacceptable behavior by participants include:
24
+
25
+ * The use of sexualized language or imagery and unwelcome sexual attention or
26
+ advances
27
+ * Trolling, insulting/derogatory comments, and personal or political attacks
28
+ * Public or private harassment
29
+ * Publishing others' private information, such as a physical or electronic
30
+ address, without explicit permission
31
+ * Other conduct which could reasonably be considered inappropriate in a
32
+ professional setting
33
+
34
+ ## Our Responsibilities
35
+
36
+ Project maintainers are responsible for clarifying the standards of acceptable
37
+ behavior and are expected to take appropriate and fair corrective action in
38
+ response to any instances of unacceptable behavior.
39
+
40
+ Project maintainers have the right and responsibility to remove, edit, or
41
+ reject comments, commits, code, wiki edits, issues, and other contributions
42
+ that are not aligned to this Code of Conduct, or to ban temporarily or
43
+ permanently any contributor for other behaviors that they deem inappropriate,
44
+ threatening, offensive, or harmful.
45
+
46
+ ## Scope
47
+
48
+ This Code of Conduct applies both within project spaces and in public spaces
49
+ when an individual is representing the project or its community. Examples of
50
+ representing a project or community include using an official project e-mail
51
+ address, posting via an official social media account, or acting as an appointed
52
+ representative at an online or offline event. Representation of a project may be
53
+ further defined and clarified by project maintainers.
54
+
55
+ ## Enforcement
56
+
57
+ Instances of abusive, harassing, or otherwise unacceptable behavior may be
58
+ reported by contacting the project team at elliott.a.young@gmail.com. All
59
+ complaints will be reviewed and investigated and will result in a response that
60
+ is deemed necessary and appropriate to the circumstances. The project team is
61
+ obligated to maintain confidentiality with regard to the reporter of an incident.
62
+ Further details of specific enforcement policies may be posted separately.
63
+
64
+ Project maintainers who do not follow or enforce the Code of Conduct in good
65
+ faith may face temporary or permanent repercussions as determined by other
66
+ members of the project's leadership.
67
+
68
+ ## Attribution
69
+
70
+ This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
71
+ available at [http://contributor-covenant.org/version/1/4][version]
72
+
73
+ [homepage]: http://contributor-covenant.org
74
+ [version]: http://contributor-covenant.org/version/1/4/
data/Gemfile ADDED
@@ -0,0 +1,6 @@
1
+ source "https://rubygems.org"
2
+
3
+ git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
4
+
5
+ # Specify your gem's dependencies in upkey-chatterly-client.gemspec
6
+ gemspec
data/LICENSE.txt ADDED
@@ -0,0 +1,21 @@
1
+ The MIT License (MIT)
2
+
3
+ Copyright (c) 2017 ElliottAYoung
4
+
5
+ Permission is hereby granted, free of charge, to any person obtaining a copy
6
+ of this software and associated documentation files (the "Software"), to deal
7
+ in the Software without restriction, including without limitation the rights
8
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
+ copies of the Software, and to permit persons to whom the Software is
10
+ furnished to do so, subject to the following conditions:
11
+
12
+ The above copyright notice and this permission notice shall be included in
13
+ all copies or substantial portions of the Software.
14
+
15
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
21
+ THE SOFTWARE.
data/README.md ADDED
@@ -0,0 +1,60 @@
1
+ # Upkey Chatterly Client
2
+
3
+ The Upkey Chatterly Client is a Ruby client used for providing a simple, standardized interface for the Upkey::Chatterly API. Using it will allow you to easily simulate a ChatBot interface and provide interactive dialog for your Users.
4
+
5
+ ## Installation
6
+
7
+ Add this line to your application's Gemfile:
8
+
9
+ ```ruby
10
+ gem 'upkey-chatterly-client'
11
+ ```
12
+
13
+ And then execute:
14
+
15
+ $ bundle
16
+
17
+ Or install it yourself as:
18
+
19
+ $ gem install upkey-chatterly-client
20
+
21
+ ## Usage
22
+
23
+ To begin you will want to create a file named `chatterly.rb` in `config/initializers`. This is where we are going to create the global client.
24
+
25
+ ```ruby
26
+ $chatterly = Upkey::Chatterly::Client.new({
27
+ access_key: YOUR_ACCESS_KEY,
28
+ chatterly_url: CHATTERLY_URL
29
+ })
30
+ ```
31
+
32
+ This will create a useable client, saved in `$chatterly`. There are now two instances where we would use this client: Getting the initial message of a conversation and responding to the User. These are their steps:
33
+
34
+ ```ruby
35
+ #Getting the Initial Message
36
+ $chatterly.respond(:topic, topic_id)
37
+
38
+ #Respoding to a User
39
+ $chatterly.respond(:response, response_id)
40
+ ```
41
+
42
+ Both will respond with an `Upkey::Chatterly::Response` object, with two attributes: `message`, which will return the next message in the conversation (either the initial one for a topic or what the response linked to), and `responses`, which contains an array of options to respond to the given message.
43
+
44
+ ## Development
45
+
46
+ 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.
47
+
48
+ 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).
49
+
50
+ ## Contributing
51
+
52
+ Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/upkey-chatterly-client. 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.
53
+
54
+ ## License
55
+
56
+ The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
57
+
58
+ ## Code of Conduct
59
+
60
+ Everyone interacting in the Upkey::Chatterly::Client project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/beupkey/upkey-chatterly-client/blob/master/CODE_OF_CONDUCT.md).
data/Rakefile ADDED
@@ -0,0 +1,6 @@
1
+ require "bundler/gem_tasks"
2
+ require "rspec/core/rake_task"
3
+
4
+ RSpec::Core::RakeTask.new(:spec)
5
+
6
+ task :default => :spec
data/bin/console ADDED
@@ -0,0 +1,7 @@
1
+ #!/usr/bin/env ruby
2
+
3
+ require "bundler/setup"
4
+ require "upkey/chatterly/client"
5
+
6
+ require "pry"
7
+ Pry.start
data/bin/setup ADDED
@@ -0,0 +1,8 @@
1
+ #!/usr/bin/env bash
2
+ set -euo pipefail
3
+ IFS=$'\n\t'
4
+ set -vx
5
+
6
+ bundle install
7
+
8
+ # Do any other automated setup that you need to do here
@@ -0,0 +1,37 @@
1
+ module Upkey
2
+ module Chatterly
3
+ module Accessor
4
+ def self.get_message(client, key, id)
5
+ raise ChatterlyArgumentError unless key == :topic || key == :response
6
+
7
+ instance_information(client, key, id)
8
+ access_chatterly('messages')
9
+ end
10
+
11
+ def self.get_resp(client, message)
12
+ id = JSON.parse(message)['id']
13
+ instance_information(client, :message, id)
14
+
15
+ access_chatterly('responses')
16
+ end
17
+
18
+ private
19
+
20
+ class << self
21
+ def access_chatterly(route)
22
+ @client.conn.get "/api/#{@key.to_s}s/#{@id}/#{route}", access_params
23
+ end
24
+
25
+ def access_params
26
+ { access_key: @client.access_key }
27
+ end
28
+
29
+ def instance_information(client, key, id)
30
+ @client = client
31
+ @key = key
32
+ @id = id
33
+ end
34
+ end
35
+ end
36
+ end
37
+ end
@@ -0,0 +1,15 @@
1
+ module Upkey
2
+ module Chatterly
3
+ class MissingArgument
4
+ def self.alert
5
+ puts "================================================================="
6
+ puts ""
7
+ puts "You are missing credentials for Upkey::Chatterly::Client"
8
+ puts "You will not be able to access Chatterly without these credentials"
9
+ puts "Please see https://github.com/beupkey/upkey-chatterly-client.git for more information"
10
+ puts ""
11
+ puts "================================================================="
12
+ end
13
+ end
14
+ end
15
+ end
@@ -0,0 +1,44 @@
1
+ require 'upkey/chatterly/accessor'
2
+ require 'upkey/chatterly/response'
3
+
4
+ require 'upkey/chatterly/alerts/missing_argument'
5
+ require 'upkey/chatterly/errors/chatterly_argument_error'
6
+
7
+ require 'faraday'
8
+ require 'json'
9
+
10
+ module Upkey
11
+ module Chatterly
12
+ class Client
13
+ attr_reader :access_key, :chatterly_url, :conn
14
+
15
+ def initialize(args = {})
16
+ MissingArgument.alert unless args[:access_key] && args[:chatterly_url]
17
+
18
+ @access_key = args[:access_key]
19
+ @chatterly_url = args[:chatterly_url]
20
+ @conn = set_up_faraday
21
+ end
22
+
23
+ def respond(args = {})
24
+ key = args[:key]
25
+ id = args[:id]
26
+
27
+ message = Upkey::Chatterly::Accessor.get_message(self, key, id)
28
+ resp = Upkey::Chatterly::Accessor.get_resp(self, message.body)
29
+
30
+ Upkey::Chatterly::Response.new(message, resp)
31
+ end
32
+
33
+ private
34
+
35
+ def set_up_faraday
36
+ Faraday.new(:url => @chatterly_url) do |faraday|
37
+ faraday.request :url_encoded
38
+ faraday.response :logger
39
+ faraday.adapter Faraday.default_adapter
40
+ end
41
+ end
42
+ end
43
+ end
44
+ end
@@ -0,0 +1,9 @@
1
+ module Upkey
2
+ module Chatterly
3
+ class ChatterlyArgumentError < ArgumentError
4
+ def initialize(msg="The key you have entered is not valid. Valid keys: [:topic, :response]")
5
+ super
6
+ end
7
+ end
8
+ end
9
+ end
@@ -0,0 +1,22 @@
1
+ module Upkey
2
+ module Chatterly
3
+ class Response
4
+ attr_reader :message, :responses
5
+
6
+ def initialize(message, responses)
7
+ return empty_set unless message.status == 200 || responses.status == 200
8
+
9
+ @message = JSON.parse(message)
10
+ @responses = JSON.parse(responses)
11
+ @status = 200
12
+ end
13
+
14
+ private
15
+
16
+ def empty_set
17
+ @message = {}
18
+ @responses = {}
19
+ end
20
+ end
21
+ end
22
+ end
@@ -0,0 +1,5 @@
1
+ module Upkey
2
+ module Chatterly
3
+ VERSION = "1.0.0"
4
+ end
5
+ end
@@ -0,0 +1,6 @@
1
+ require "upkey/chatterly/version"
2
+
3
+ module Upkey
4
+ module Chatterly
5
+ end
6
+ end
@@ -0,0 +1,29 @@
1
+ # coding: utf-8
2
+ lib = File.expand_path("../lib", __FILE__)
3
+ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
4
+ require "upkey/chatterly/version"
5
+
6
+ Gem::Specification.new do |spec|
7
+ spec.name = "upkey-chatterly-client"
8
+ spec.version = Upkey::Chatterly::VERSION
9
+ spec.authors = ["ElliottAYoung"]
10
+ spec.email = ["elliott.a.young@gmail.com"]
11
+
12
+ spec.summary = "The Ruby Client for the Upkey Chatterly API"
13
+ spec.description = "The Ruby Client for the Upkey Chatterly API"
14
+ spec.homepage = "https://github.com/beupkey/upkey-chatterly-client.git"
15
+ spec.license = "MIT"
16
+
17
+ spec.files = `git ls-files -z`.split("\x0").reject do |f|
18
+ f.match(%r{^(test|spec|features)/})
19
+ end
20
+ spec.bindir = "exe"
21
+ spec.executables = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
22
+ spec.require_paths = ["lib"]
23
+
24
+ spec.add_development_dependency "bundler", "~> 1.15"
25
+ spec.add_development_dependency "rake", "~> 10.0"
26
+ spec.add_development_dependency "rspec", "~> 3.0"
27
+ spec.add_development_dependency "pry"
28
+ spec.add_development_dependency "faraday"
29
+ end
metadata ADDED
@@ -0,0 +1,132 @@
1
+ --- !ruby/object:Gem::Specification
2
+ name: upkey-chatterly-client
3
+ version: !ruby/object:Gem::Version
4
+ version: 1.0.0
5
+ platform: ruby
6
+ authors:
7
+ - ElliottAYoung
8
+ autorequire:
9
+ bindir: exe
10
+ cert_chain: []
11
+ date: 2017-08-29 00:00:00.000000000 Z
12
+ dependencies:
13
+ - !ruby/object:Gem::Dependency
14
+ name: bundler
15
+ requirement: !ruby/object:Gem::Requirement
16
+ requirements:
17
+ - - "~>"
18
+ - !ruby/object:Gem::Version
19
+ version: '1.15'
20
+ type: :development
21
+ prerelease: false
22
+ version_requirements: !ruby/object:Gem::Requirement
23
+ requirements:
24
+ - - "~>"
25
+ - !ruby/object:Gem::Version
26
+ version: '1.15'
27
+ - !ruby/object:Gem::Dependency
28
+ name: rake
29
+ requirement: !ruby/object:Gem::Requirement
30
+ requirements:
31
+ - - "~>"
32
+ - !ruby/object:Gem::Version
33
+ version: '10.0'
34
+ type: :development
35
+ prerelease: false
36
+ version_requirements: !ruby/object:Gem::Requirement
37
+ requirements:
38
+ - - "~>"
39
+ - !ruby/object:Gem::Version
40
+ version: '10.0'
41
+ - !ruby/object:Gem::Dependency
42
+ name: rspec
43
+ requirement: !ruby/object:Gem::Requirement
44
+ requirements:
45
+ - - "~>"
46
+ - !ruby/object:Gem::Version
47
+ version: '3.0'
48
+ type: :development
49
+ prerelease: false
50
+ version_requirements: !ruby/object:Gem::Requirement
51
+ requirements:
52
+ - - "~>"
53
+ - !ruby/object:Gem::Version
54
+ version: '3.0'
55
+ - !ruby/object:Gem::Dependency
56
+ name: pry
57
+ requirement: !ruby/object:Gem::Requirement
58
+ requirements:
59
+ - - ">="
60
+ - !ruby/object:Gem::Version
61
+ version: '0'
62
+ type: :development
63
+ prerelease: false
64
+ version_requirements: !ruby/object:Gem::Requirement
65
+ requirements:
66
+ - - ">="
67
+ - !ruby/object:Gem::Version
68
+ version: '0'
69
+ - !ruby/object:Gem::Dependency
70
+ name: faraday
71
+ requirement: !ruby/object:Gem::Requirement
72
+ requirements:
73
+ - - ">="
74
+ - !ruby/object:Gem::Version
75
+ version: '0'
76
+ type: :development
77
+ prerelease: false
78
+ version_requirements: !ruby/object:Gem::Requirement
79
+ requirements:
80
+ - - ">="
81
+ - !ruby/object:Gem::Version
82
+ version: '0'
83
+ description: The Ruby Client for the Upkey Chatterly API
84
+ email:
85
+ - elliott.a.young@gmail.com
86
+ executables: []
87
+ extensions: []
88
+ extra_rdoc_files: []
89
+ files:
90
+ - ".gitignore"
91
+ - ".rspec"
92
+ - ".travis.yml"
93
+ - CODE_OF_CONDUCT.md
94
+ - Gemfile
95
+ - LICENSE.txt
96
+ - README.md
97
+ - Rakefile
98
+ - bin/console
99
+ - bin/setup
100
+ - lib/upkey/chatterly.rb
101
+ - lib/upkey/chatterly/accessor.rb
102
+ - lib/upkey/chatterly/alerts/missing_argument.rb
103
+ - lib/upkey/chatterly/client.rb
104
+ - lib/upkey/chatterly/errors/chatterly_argument_error.rb
105
+ - lib/upkey/chatterly/response.rb
106
+ - lib/upkey/chatterly/version.rb
107
+ - upkey-chatterly-client.gemspec
108
+ homepage: https://github.com/beupkey/upkey-chatterly-client.git
109
+ licenses:
110
+ - MIT
111
+ metadata: {}
112
+ post_install_message:
113
+ rdoc_options: []
114
+ require_paths:
115
+ - lib
116
+ required_ruby_version: !ruby/object:Gem::Requirement
117
+ requirements:
118
+ - - ">="
119
+ - !ruby/object:Gem::Version
120
+ version: '0'
121
+ required_rubygems_version: !ruby/object:Gem::Requirement
122
+ requirements:
123
+ - - ">="
124
+ - !ruby/object:Gem::Version
125
+ version: '0'
126
+ requirements: []
127
+ rubyforge_project:
128
+ rubygems_version: 2.6.12
129
+ signing_key:
130
+ specification_version: 4
131
+ summary: The Ruby Client for the Upkey Chatterly API
132
+ test_files: []