upkey-chatterly-client 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: dc08f565050dbf4564c8bf2ce9e701382576b0ef
+  data.tar.gz: 802d47cadc5eed2285d420f8395742b0e3f73ff6
+SHA512:
+  metadata.gz: 8c875820c10922057843da08dd3aeaad16efe260847b57c32377e3df46842532b3cbcf742e236715ad8046ff99386cca95ebc9b517514486c1e9310c97832f03
+  data.tar.gz: f00e95fe4dc7796edc686a81691b751465b672ec411d957566b9c4d7106dbcbbe56480c3c0f5144214aeeebcb2d8a93699f4a59433daad1a0087ffd1b056134f

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.2.4
+before_install: gem install bundler -v 1.15.3

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 elliott.a.young@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,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in upkey-chatterly-client.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 ElliottAYoung
+
+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,60 @@
+# Upkey Chatterly Client
+
+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.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'upkey-chatterly-client'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install upkey-chatterly-client
+
+## Usage
+
+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.
+
+```ruby
+$chatterly = Upkey::Chatterly::Client.new({
+	access_key: YOUR_ACCESS_KEY,
+	chatterly_url: CHATTERLY_URL
+})
+```
+
+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:
+
+```ruby
+#Getting the Initial Message
+$chatterly.respond(:topic, topic_id)
+
+#Respoding to a User
+$chatterly.respond(:response, response_id)
+```
+
+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.
+
+## 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]/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.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+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

@@ -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,7 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "upkey/chatterly/client"
+
+require "pry"
+Pry.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/lib/upkey/chatterly/accessor.rb

@@ -0,0 +1,37 @@
+module Upkey
+  module Chatterly
+    module Accessor
+      def self.get_message(client, key, id)
+        raise ChatterlyArgumentError unless key == :topic || key == :response
+
+        instance_information(client, key, id)
+        access_chatterly('messages')
+      end
+
+      def self.get_resp(client, message)
+        id = JSON.parse(message)['id']
+        instance_information(client, :message, id)
+
+        access_chatterly('responses')
+      end
+
+      private
+
+      class << self
+        def access_chatterly(route)
+          @client.conn.get "/api/#{@key.to_s}s/#{@id}/#{route}", access_params
+        end
+
+        def access_params
+          { access_key: @client.access_key }
+        end
+
+        def instance_information(client, key, id)
+          @client = client
+          @key = key
+          @id = id
+        end
+      end
+    end
+  end
+end

data/lib/upkey/chatterly/alerts/missing_argument.rb

@@ -0,0 +1,15 @@
+module Upkey
+  module Chatterly
+    class MissingArgument
+      def self.alert
+        puts "================================================================="
+        puts ""
+        puts "You are missing credentials for Upkey::Chatterly::Client"
+        puts "You will not be able to access Chatterly without these credentials"
+        puts "Please see https://github.com/beupkey/upkey-chatterly-client.git for more information"
+        puts ""
+        puts "================================================================="
+      end
+    end
+  end
+end

data/lib/upkey/chatterly/client.rb

@@ -0,0 +1,44 @@
+require 'upkey/chatterly/accessor'
+require 'upkey/chatterly/response'
+
+require 'upkey/chatterly/alerts/missing_argument'
+require 'upkey/chatterly/errors/chatterly_argument_error'
+
+require 'faraday'
+require 'json'
+
+module Upkey
+  module Chatterly
+    class Client
+      attr_reader :access_key, :chatterly_url, :conn
+
+      def initialize(args = {})
+        MissingArgument.alert unless args[:access_key] && args[:chatterly_url]
+
+        @access_key = args[:access_key]
+        @chatterly_url = args[:chatterly_url]
+        @conn = set_up_faraday
+      end
+
+      def respond(args = {})
+        key = args[:key]
+        id = args[:id]
+
+        message = Upkey::Chatterly::Accessor.get_message(self, key, id)
+        resp = Upkey::Chatterly::Accessor.get_resp(self, message.body)
+
+        Upkey::Chatterly::Response.new(message, resp)
+      end
+
+      private
+
+      def set_up_faraday
+        Faraday.new(:url => @chatterly_url) do |faraday|
+          faraday.request  :url_encoded
+          faraday.response :logger
+          faraday.adapter  Faraday.default_adapter
+        end
+      end
+    end
+  end
+end

data/lib/upkey/chatterly/errors/chatterly_argument_error.rb

@@ -0,0 +1,9 @@
+module Upkey
+  module Chatterly
+    class ChatterlyArgumentError < ArgumentError
+      def initialize(msg="The key you have entered is not valid. Valid keys: [:topic, :response]")
+        super
+      end
+    end
+  end
+end

data/lib/upkey/chatterly/response.rb

@@ -0,0 +1,22 @@
+module Upkey
+  module Chatterly
+    class Response
+      attr_reader :message, :responses
+
+      def initialize(message, responses)
+        return empty_set unless message.status == 200 || responses.status == 200
+
+        @message = JSON.parse(message)
+        @responses = JSON.parse(responses)
+        @status = 200
+      end
+
+      private
+
+      def empty_set
+        @message = {}
+        @responses = {}
+      end
+    end
+  end
+end

data/lib/upkey/chatterly/version.rb

@@ -0,0 +1,5 @@
+module Upkey
+  module Chatterly
+    VERSION = "1.0.0"
+  end
+end

data/lib/upkey/chatterly.rb

@@ -0,0 +1,6 @@
+require "upkey/chatterly/version"
+
+module Upkey
+  module Chatterly
+  end
+end

data/upkey-chatterly-client.gemspec

@@ -0,0 +1,29 @@
+# coding: utf-8
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "upkey/chatterly/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "upkey-chatterly-client"
+  spec.version       = Upkey::Chatterly::VERSION
+  spec.authors       = ["ElliottAYoung"]
+  spec.email         = ["elliott.a.young@gmail.com"]
+
+  spec.summary       = "The Ruby Client for the Upkey Chatterly API"
+  spec.description   = "The Ruby Client for the Upkey Chatterly API"
+  spec.homepage      = "https://github.com/beupkey/upkey-chatterly-client.git"
+  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.15"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "pry"
+  spec.add_development_dependency "faraday"
+end

metadata

@@ -0,0 +1,132 @@
+--- !ruby/object:Gem::Specification
+name: upkey-chatterly-client
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- ElliottAYoung
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-08-29 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+- !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: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: The Ruby Client for the Upkey Chatterly API
+email:
+- elliott.a.young@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
+- lib/upkey/chatterly.rb
+- lib/upkey/chatterly/accessor.rb
+- lib/upkey/chatterly/alerts/missing_argument.rb
+- lib/upkey/chatterly/client.rb
+- lib/upkey/chatterly/errors/chatterly_argument_error.rb
+- lib/upkey/chatterly/response.rb
+- lib/upkey/chatterly/version.rb
+- upkey-chatterly-client.gemspec
+homepage: https://github.com/beupkey/upkey-chatterly-client.git
+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.6.12
+signing_key: 
+specification_version: 4
+summary: The Ruby Client for the Upkey Chatterly API
+test_files: []