gist-ruby 0.1.0

Sign up to get free protection for your applications and to get access to all the features.
@@ -0,0 +1,7 @@
1
+ ---
2
+ SHA256:
3
+ metadata.gz: 720b3152787b764aaf04b993a4400e5598ec02f7f0b828f1787e4957e5d539d3
4
+ data.tar.gz: 327adef1750733792b58422aaf5c3a87a338e2e2281c1371d029563da0ed995d
5
+ SHA512:
6
+ metadata.gz: bd207e1c747f62698f01af7a3758bbf3cb3316b2207014eb8e8124dd7453a097d10cefbd87fd6f2fcba7b92f859d0c641ef5ef19ea3e8da04a479bf03a3966dd
7
+ data.tar.gz: 0abaf61b3ad2cda2b4da5fe0ac868753bc9630d9d97fe36b8ca508432e10110cb11e7e0f118b109e23dfab6361a8590c8bc3272655ce95e654ceb40cf731930e
@@ -0,0 +1,11 @@
1
+ /.bundle/
2
+ /.yardoc
3
+ /_yardoc/
4
+ /coverage/
5
+ /doc/
6
+ /pkg/
7
+ /spec/reports/
8
+ /tmp/
9
+
10
+ # rspec failure tracking
11
+ .rspec_status
data/.rspec ADDED
@@ -0,0 +1,3 @@
1
+ --format documentation
2
+ --color
3
+ --require spec_helper
@@ -0,0 +1,7 @@
1
+ ---
2
+ sudo: false
3
+ language: ruby
4
+ cache: bundler
5
+ rvm:
6
+ - 2.6.1
7
+ before_install: gem install bundler -v 1.17.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 hannahmasila@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 gist-ruby-client.gemspec
6
+ gemspec
@@ -0,0 +1,53 @@
1
+ PATH
2
+ remote: .
3
+ specs:
4
+ gist-ruby (0.1.0)
5
+ rest-client
6
+
7
+ GEM
8
+ remote: https://rubygems.org/
9
+ specs:
10
+ diff-lcs (1.3)
11
+ domain_name (0.5.20190701)
12
+ unf (>= 0.0.5, < 1.0.0)
13
+ http-accept (1.7.0)
14
+ http-cookie (1.0.3)
15
+ domain_name (~> 0.5)
16
+ mime-types (3.3.1)
17
+ mime-types-data (~> 3.2015)
18
+ mime-types-data (3.2020.0512)
19
+ netrc (0.11.0)
20
+ rake (10.5.0)
21
+ rest-client (2.1.0)
22
+ http-accept (>= 1.7.0, < 2.0)
23
+ http-cookie (>= 1.0.2, < 2.0)
24
+ mime-types (>= 1.16, < 4.0)
25
+ netrc (~> 0.8)
26
+ rspec (3.9.0)
27
+ rspec-core (~> 3.9.0)
28
+ rspec-expectations (~> 3.9.0)
29
+ rspec-mocks (~> 3.9.0)
30
+ rspec-core (3.9.2)
31
+ rspec-support (~> 3.9.3)
32
+ rspec-expectations (3.9.2)
33
+ diff-lcs (>= 1.2.0, < 2.0)
34
+ rspec-support (~> 3.9.0)
35
+ rspec-mocks (3.9.1)
36
+ diff-lcs (>= 1.2.0, < 2.0)
37
+ rspec-support (~> 3.9.0)
38
+ rspec-support (3.9.3)
39
+ unf (0.1.4)
40
+ unf_ext
41
+ unf_ext (0.0.7.7)
42
+
43
+ PLATFORMS
44
+ ruby
45
+
46
+ DEPENDENCIES
47
+ bundler (~> 2.1.4)
48
+ gist-ruby!
49
+ rake (~> 10.0)
50
+ rspec (~> 3.0)
51
+
52
+ BUNDLED WITH
53
+ 2.1.4
@@ -0,0 +1,21 @@
1
+ The MIT License (MIT)
2
+
3
+ Copyright (c) 2020 Hannah Masila
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.
@@ -0,0 +1,43 @@
1
+ # Gist::Ruby::Client
2
+
3
+ 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/gist/ruby/client`. To experiment with that code, run `bin/console` for an interactive prompt.
4
+
5
+ TODO: Delete this and the text above, and describe your gem
6
+
7
+ ## Installation
8
+
9
+ Add this line to your application's Gemfile:
10
+
11
+ ```ruby
12
+ gem 'gist-ruby-client'
13
+ ```
14
+
15
+ And then execute:
16
+
17
+ $ bundle
18
+
19
+ Or install it yourself as:
20
+
21
+ $ gem install gist-ruby-client
22
+
23
+ ## Usage
24
+
25
+ TODO: Write usage instructions here
26
+
27
+ ## Development
28
+
29
+ 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.
30
+
31
+ 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).
32
+
33
+ ## Contributing
34
+
35
+ Bug reports and pull requests are welcome on GitHub at https://github.com/hmasila/gist-ruby-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.
36
+
37
+ ## License
38
+
39
+ The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
40
+
41
+ ## Code of Conduct
42
+
43
+ Everyone interacting in the Gist::Ruby::Client project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/hmasila/gist-ruby-client/blob/master/CODE_OF_CONDUCT.md).
@@ -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
@@ -0,0 +1,14 @@
1
+ #!/usr/bin/env ruby
2
+
3
+ require "bundler/setup"
4
+ require "gist-ruby"
5
+
6
+ # You can add fixtures and/or initialization code here to make experimenting
7
+ # with your gem easier. You can also use a different console, if you like.
8
+
9
+ # (If you use this, don't forget to add pry to your Gemfile!)
10
+ # require "pry"
11
+ # Pry.start
12
+
13
+ require "irb"
14
+ IRB.start(__FILE__)
@@ -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,41 @@
1
+
2
+ lib = File.expand_path("../lib", __FILE__)
3
+ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
4
+ require "gist/ruby/version"
5
+
6
+ Gem::Specification.new do |spec|
7
+ spec.name = "gist-ruby"
8
+ spec.version = Gist::Ruby::VERSION
9
+ spec.authors = ["Hannah Masila"]
10
+ spec.email = ["hannahmasila@gmail.com"]
11
+
12
+ spec.summary = %q{A Gist Ruby client used to integrate Gist into other software applications and custom workflows.}
13
+ spec.description = %q{Gist is a customer communication and marketing automation platform that helps you grow your business and engage with your customers across their lifecycle.
14
+ It is a complete marketing and growth stack for your business - with live chat, email marketing, automation, event tracking and lead gen forms }
15
+ spec.homepage = "https://rubygems.org/gems/gist-ruby"
16
+ spec.license = "MIT"
17
+
18
+ # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
19
+ # to allow pushing to a single host or delete this section to allow pushing to any host.
20
+ if spec.respond_to?(:metadata)
21
+ spec.metadata["homepage_uri"] = spec.homepage
22
+ spec.metadata["source_code_uri"] = "https://github.com/hmasila/gist-ruby-client"
23
+ else
24
+ raise "RubyGems 2.0 or newer is required to protect against " \
25
+ "public gem pushes."
26
+ end
27
+
28
+ # Specify which files should be added to the gem when it is released.
29
+ # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
30
+ spec.files = Dir.chdir(File.expand_path('..', __FILE__)) do
31
+ `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
32
+ end
33
+ spec.bindir = "exe"
34
+ spec.executables = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
35
+ spec.require_paths = ["lib"]
36
+
37
+ spec.add_dependency "rest-client"
38
+ spec.add_development_dependency "bundler", "~> 2.1.4"
39
+ spec.add_development_dependency "rake", "~> 10.0"
40
+ spec.add_development_dependency "rspec", "~> 3.0"
41
+ end
@@ -0,0 +1,9 @@
1
+ require "gist/ruby/version"
2
+ require 'rest-client'
3
+ require 'json'
4
+ require 'gist/client'
5
+
6
+ module Gist
7
+ class Error < StandardError; end
8
+ # Your code goes here...
9
+ end
@@ -0,0 +1,137 @@
1
+ # frozen_string_literal: true
2
+
3
+ module Gist
4
+ class Client
5
+ API_URL = 'https://api.getgist.com'
6
+
7
+ attr_accessor :access_token
8
+
9
+ def initialize(access_token)
10
+ @access_token = access_token
11
+ end
12
+
13
+ def connect(payload: {}, params: {}, method:, endpoint:)
14
+ RestClient::Request.execute(
15
+ method: method,
16
+ url: "#{API_URL}/#{endpoint}",
17
+ payload: payload.to_json,
18
+ headers: {
19
+ content_type: 'application/json',
20
+ Authorization: "Bearer #{@access_token}",
21
+ params: params
22
+ }) do |response, request, result|
23
+ case response.code
24
+ when 400
25
+ [ :error, JSON.parse(response.to_str) ]
26
+ when 200
27
+ [ :success, JSON.parse(response.to_str) ]
28
+ else
29
+ fail "Invalid response #{response.to_str} received."
30
+ end
31
+ end
32
+
33
+ rescue RestClient::Unauthorized, RestClient::Forbidden => err
34
+ JSON.parse(err.response.to_str)
35
+ end
36
+
37
+ def create_conversation(user_id: nil, email: nil, id:, body:, from:)
38
+ payload = {
39
+ from: {
40
+ id: id,
41
+ user_id: user_id,
42
+ email: email
43
+ },
44
+ body: body
45
+ }
46
+ connect(payload: payload, method: :post, endpoint: "conversations")
47
+ end
48
+
49
+ def get_conversation(id:)
50
+ connect(method: :get, endpoint: "conversations/#{id}")
51
+ end
52
+
53
+ def delete_conversation(id:)
54
+ connect(method: :delete, endpoint: "conversations/#{id}")
55
+ end
56
+
57
+ def assign_conversation(assignee_id: nil, teammate_id: , id:)
58
+ payload = {
59
+ teammate_id: teammate_id,
60
+ assignee_id: assignee_id
61
+ }
62
+ connect(payload: payload, method: :patch, endpoint: "conversations/#{id}/assign")
63
+ end
64
+
65
+ def snooze_conversation(snooze_until: nil, teammate_id:, id:)
66
+ payload = {
67
+ teammate_id: teammate_id,
68
+ state: "snoozed",
69
+ snooze_until: snooze_until
70
+ }
71
+ connect(payload: payload, method: :patch, endpoint: "conversations/#{id}")
72
+ end
73
+
74
+ def reopen_conversation(teammate_id:, id:)
75
+ payload = {
76
+ teammate_id: teammate_id,
77
+ state: "open"
78
+ }
79
+ connect(payload: payload, method: :patch, endpoint: "conversations/#{id}")
80
+ end
81
+
82
+ def close_conversation(teammate_id:, id:)
83
+ payload = {
84
+ teammate_id: teammate_id,
85
+ state: "closed"
86
+ }
87
+ connect(payload: payload, method: :patch, endpoint: "conversations/#{id}")
88
+ end
89
+
90
+ def prioritize_conversation(priority: "priority", teammate_id:, id:)
91
+ payload = {
92
+ teammate_id: teammate_id,
93
+ priority: priority
94
+ }
95
+ connect(payload: payload, method: :patch, endpoint: "conversations/#{id}/priority")
96
+ end
97
+
98
+ def list_conversations(order: "desc", status: "all", sort: "updated_at")
99
+ params = {
100
+ order: order,
101
+ status: status,
102
+ sort: sort
103
+ }
104
+ connect(params: params, method: :get, endpoint: "conversations")
105
+ end
106
+
107
+ def retrieve_conversation_count
108
+ connect(method: :get, endpoint: "conversations/count")
109
+ end
110
+
111
+ def reply_to_contact(user_id: nil, email: nil, message_type: "reply", id: nil, body:, conversation_id:)
112
+ payload = {
113
+ message_type: message_type,
114
+ from: {
115
+ id: id,
116
+ user_id: user_id,
117
+ email: email,
118
+ type: contact
119
+ },
120
+ body: body
121
+ }
122
+ connect(payload: payload, method: :get, endpoint: "conversations/#{conversation_id}/messages")
123
+ end
124
+
125
+ def reply_to_teammate(message_type: "reply", teammate_id: , body:, conversation_id:)
126
+ payload = {
127
+ message_type: message_type,
128
+ from: {
129
+ type: "teammate",
130
+ teammate_id: teammate_id
131
+ },
132
+ body: body
133
+ }
134
+ connect(payload: payload, method: :get, endpoint: "conversations/#{conversation_id}/messages")
135
+ end
136
+ end
137
+ end
@@ -0,0 +1,7 @@
1
+ # frozen_string_literal: true
2
+
3
+ module Gist
4
+ class Conversation < Client
5
+
6
+ end
7
+ end
@@ -0,0 +1,5 @@
1
+ module Gist
2
+ module Ruby
3
+ VERSION = "0.1.0"
4
+ end
5
+ end
metadata ADDED
@@ -0,0 +1,121 @@
1
+ --- !ruby/object:Gem::Specification
2
+ name: gist-ruby
3
+ version: !ruby/object:Gem::Version
4
+ version: 0.1.0
5
+ platform: ruby
6
+ authors:
7
+ - Hannah Masila
8
+ autorequire:
9
+ bindir: exe
10
+ cert_chain: []
11
+ date: 2020-06-11 00:00:00.000000000 Z
12
+ dependencies:
13
+ - !ruby/object:Gem::Dependency
14
+ name: rest-client
15
+ requirement: !ruby/object:Gem::Requirement
16
+ requirements:
17
+ - - ">="
18
+ - !ruby/object:Gem::Version
19
+ version: '0'
20
+ type: :runtime
21
+ prerelease: false
22
+ version_requirements: !ruby/object:Gem::Requirement
23
+ requirements:
24
+ - - ">="
25
+ - !ruby/object:Gem::Version
26
+ version: '0'
27
+ - !ruby/object:Gem::Dependency
28
+ name: bundler
29
+ requirement: !ruby/object:Gem::Requirement
30
+ requirements:
31
+ - - "~>"
32
+ - !ruby/object:Gem::Version
33
+ version: 2.1.4
34
+ type: :development
35
+ prerelease: false
36
+ version_requirements: !ruby/object:Gem::Requirement
37
+ requirements:
38
+ - - "~>"
39
+ - !ruby/object:Gem::Version
40
+ version: 2.1.4
41
+ - !ruby/object:Gem::Dependency
42
+ name: rake
43
+ requirement: !ruby/object:Gem::Requirement
44
+ requirements:
45
+ - - "~>"
46
+ - !ruby/object:Gem::Version
47
+ version: '10.0'
48
+ type: :development
49
+ prerelease: false
50
+ version_requirements: !ruby/object:Gem::Requirement
51
+ requirements:
52
+ - - "~>"
53
+ - !ruby/object:Gem::Version
54
+ version: '10.0'
55
+ - !ruby/object:Gem::Dependency
56
+ name: rspec
57
+ requirement: !ruby/object:Gem::Requirement
58
+ requirements:
59
+ - - "~>"
60
+ - !ruby/object:Gem::Version
61
+ version: '3.0'
62
+ type: :development
63
+ prerelease: false
64
+ version_requirements: !ruby/object:Gem::Requirement
65
+ requirements:
66
+ - - "~>"
67
+ - !ruby/object:Gem::Version
68
+ version: '3.0'
69
+ description: "Gist is a customer communication and marketing automation platform that
70
+ helps you grow your business and engage with your customers across their lifecycle.\n
71
+ \ It is a complete marketing and growth stack for your business
72
+ - with live chat, email marketing, automation, event tracking and lead gen forms "
73
+ email:
74
+ - hannahmasila@gmail.com
75
+ executables: []
76
+ extensions: []
77
+ extra_rdoc_files: []
78
+ files:
79
+ - ".gitignore"
80
+ - ".rspec"
81
+ - ".travis.yml"
82
+ - CODE_OF_CONDUCT.md
83
+ - Gemfile
84
+ - Gemfile.lock
85
+ - LICENSE.txt
86
+ - README.md
87
+ - Rakefile
88
+ - bin/console
89
+ - bin/setup
90
+ - gist-ruby.gemspec
91
+ - lib/gist-ruby.rb
92
+ - lib/gist/client.rb
93
+ - lib/gist/conversation.rb
94
+ - lib/gist/ruby/version.rb
95
+ homepage: https://rubygems.org/gems/gist-ruby
96
+ licenses:
97
+ - MIT
98
+ metadata:
99
+ homepage_uri: https://rubygems.org/gems/gist-ruby
100
+ source_code_uri: https://github.com/hmasila/gist-ruby-client
101
+ post_install_message:
102
+ rdoc_options: []
103
+ require_paths:
104
+ - lib
105
+ required_ruby_version: !ruby/object:Gem::Requirement
106
+ requirements:
107
+ - - ">="
108
+ - !ruby/object:Gem::Version
109
+ version: '0'
110
+ required_rubygems_version: !ruby/object:Gem::Requirement
111
+ requirements:
112
+ - - ">="
113
+ - !ruby/object:Gem::Version
114
+ version: '0'
115
+ requirements: []
116
+ rubygems_version: 3.1.2
117
+ signing_key:
118
+ specification_version: 4
119
+ summary: A Gist Ruby client used to integrate Gist into other software applications
120
+ and custom workflows.
121
+ test_files: []