convertkit-ruby 0.0.5

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: ffa2c590c805d4b469e21a2317d06fe9f7cda67ecdaf012ab8c56a35d78aa7e3
+  data.tar.gz: 556327cb6b3f4b869051fd5fa44711edd1798bc7a5f64a5056b805e30a8be742
+SHA512:
+  metadata.gz: 0e2e3d45951fe679c11106820919a91226d7804ddf7b6a7389d1cfb7cb464093e0334b7e86af536a065dedc59ae9bdf677f9a1c3f398d79868f6f0643161702b
+  data.tar.gz: bb71306553a06a4a6bd5fb6c6c7ce137eb596250db5deff1d391da19fb6ab91ec6a4a51a8d915308ffe44675fe3afb799789a6e3d618ac7156d9cc0a0963297a

data/.github/workflows/ruby.yml

@@ -0,0 +1,20 @@
+name: Ruby
+
+on: [push, pull_request]
+
+jobs:
+  build:
+
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v1
+    - name: Set up Ruby 2.6
+      uses: actions/setup-ruby@v1
+      with:
+        ruby-version: 2.6.x
+    - name: Build and test with Rake
+      run: |
+        gem install bundler
+        bundle install --jobs 4 --retry 3
+        bundle exec rake

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+.DS_Store
+.env.local

data/.rspec

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

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.2.3
+before_install: gem install bundler -v 1.11.2

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,49 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, and in the interest of
+fostering an open and welcoming community, we pledge to respect all people who
+contribute through reporting issues, posting feature requests, updating
+documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free
+experience for everyone, regardless of level of experience, gender, gender
+identity and expression, sexual orientation, disability, personal appearance,
+body size, race, ethnicity, age, religion, or nationality.
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery
+* Personal attacks
+* Trolling or insulting/derogatory comments
+* Public or private harassment
+* Publishing other's private information, such as physical or electronic
+  addresses, without explicit permission
+* Other unethical or unprofessional conduct
+
+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.
+
+By adopting this Code of Conduct, project maintainers commit themselves to
+fairly and consistently applying these principles to every aspect of managing
+this project. Project maintainers who do not follow or enforce the Code of
+Conduct may be permanently removed from the project team.
+
+This code of conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting a project maintainer at rkcudjoe@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. Maintainers are
+obligated to maintain confidentiality with regard to the reporter of an
+incident.
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 1.3.0, available at
+[http://contributor-covenant.org/version/1/3/0/][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/3/0/

data/Gemfile

@@ -0,0 +1,8 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in convertkit-ruby.gemspec
+gemspec
+
+gem 'dotenv', '~> 2.1', '>= 2.1.1'
+gem 'webmock', '~> 2.1'
+gem 'vcr', '~> 3.0', '>= 3.0.3'

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Hook Engine
+
+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,112 @@
+# Convertkit Ruby Client
+
+A Ruby toolkit for [Convertkit](https://convertkit.com/) API.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'convertkit-ruby', require: 'convertkit'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install convertkit-ruby
+
+## Authentication
+
+For private integrations, use your personal ``API_KEY`` and ``API_SECRET`` found in [your account settings.](https://app.convertkit.com/account/edit)
+
+```ruby
+require "dotenv"
+Dotenv.load(".env.local")
+
+Convertkit.configure do |config|
+  config.api_secret = ENV["API_SECRET"]
+  config.api_key = ENV["API_KEY"]
+end
+
+client = Convertkit::Client.new
+```
+
+## Usage
+
+Calls for Convertkit API v3 are relative to the url [http://api.convertkit.com/v3](http://api.convertkit.com/v3).
+
+API actions are available as methods on the client object. Currently, the Convertkit client has the following methods:
+
+
+| Action                       | Method                                                          |
+|:-----------------------------|:----------------------------------------------------------------|
+| Get account information      | `#account`                                                      |
+| List subscribers             | `#subscribers(options = {})`                                    |
+| Fetch a subscriber           | `#subscriber(subscriber_id)`                                    |
+| List sequences/courses       | `#sequences`                                                    |
+| Add subscriber to sequence   | `#add_subscriber_to_sequence(sequence_id, email, options = {})` |
+| List tags                    | `#tags`                                                         |
+| Add subscriber to tag        | `#add_subscriber_to_tag(tag_id, email, options = {})`           |
+| Remove tag from a subscriber | `#remove_tag_from_subscriber(subscriber_id, tag_id)`            |
+| List forms                   | `#forms`                                                        |
+| Add subscriber to form       | `#add_subscriber_to_form(form_id, email, options = {})`         |
+| Unsubscribe                  | `#unsubscribe(email)`                                           |
+
+**Note:** We do not have complete API coverage yet. If we are missing an API method that you need to use in your application, please file an issue and/or open a pull request. 
+
+[See the official API documentation](http://kb.convertkit.com/article/api-documentation-v3/) for a complete API reference.
+
+## Use Cases
+
+Here are some common use cases for the Convertkit v3 API client.
+
+First configure the ``convertkit-ruby`` gem with your ``API_KEY`` and ``API_SECRET``, and initialize a new client. After that, you can fetch data from your account.
+
+### List subscribers
+
+List all subscribers added to your account on or after a specific date.
+
+```ruby
+response = client.subscribers(from: "2016-03-01")
+# => <Faraday::Response ...>
+
+response.status
+# => 200
+```
+
+### Fetching subscriber data
+
+Subscribers can be looked up by their ``subscriber_id``.
+
+```ruby
+response = client.subscriber("17682009")
+# => <Faraday::Response ...>
+
+response.status
+# => 200
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, copy `.env.local.sample` to `.env.local` and substitute your own real values from your account. Finally, 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/Atomoworks/convertkit-ruby. 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.
+
+1. Fork it ( https://github.com/Atomoworks/convertkit-ruby/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request
+
+## 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,22 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "convertkit"
+require "dotenv"
+
+Dotenv.load(".env.local")
+
+Convertkit.configure do |config|
+  config.api_secret = ENV["API_SECRET"]
+  config.api_key = ENV["API_KEY"]
+end
+
+# 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/convertkit-ruby.gemspec

@@ -0,0 +1,39 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'convertkit/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "convertkit-ruby"
+  spec.version       = Convertkit::VERSION
+  spec.authors       = ["Raymond Cudjoe","Hook Engine"]
+  spec.email         = ["rkcudjoe@gmail.com","rkcudjoe@hookengine.com"]
+
+  spec.summary       = %q{A Ruby gem for interacting with the ConvertKit API v3}
+  spec.description   = %q{A simple wrapper for the ConvertKit API}
+  spec.homepage      = "http://hookengine.com"
+  spec.license       = "MIT"
+
+  # Prevent pushing this gem to RubyGems.org by setting 'allowed_push_host', or
+  # delete this section to allow pushing this gem 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 { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "dotenv", "~> 2.1"
+
+  spec.add_runtime_dependency "faraday", "~> 1.0"
+  spec.add_runtime_dependency "faraday_middleware", "~> 1.0"
+  spec.add_runtime_dependency "json", '>= 1.8.3'
+end

data/fixtures/vcr_cassettes/account.yml

@@ -0,0 +1,65 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: https://api.convertkit.com/v3/account?api_key=<API_KEY>&api_secret=<API_SECRET>
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      User-Agent:
+      - Convertkit-Ruby v0.0.2
+      Content-Type:
+      - application/vnd.api+json
+      Accept:
+      - "*/*"
+      Accept-Encoding:
+      - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Server:
+      - Cowboy
+      Date:
+      - Wed, 17 Jan 2018 09:10:11 GMT
+      Connection:
+      - keep-alive
+      Strict-Transport-Security:
+      - max-age=31536000
+      X-Frame-Options:
+      - ALLOWALL
+      X-Xss-Protection:
+      - 1; mode=block
+      X-Content-Type-Options:
+      - nosniff
+      X-Ua-Compatible:
+      - chrome=1
+      Content-Type:
+      - application/json; charset=utf-8
+      Etag:
+      - '"31780a9f8927b4bd79eabb594a810a34"'
+      Cache-Control:
+      - max-age=0, private, must-revalidate
+      Set-Cookie:
+      - XSRF-TOKEN=diVno%2FS7V7GFb4pbqOovRPnLYFLZ3ZzxHwkwWA6UN0aWW8KoIhJVeGajXm1oQdEkQoN5vcNEMgrgYKVe6io5ZQ%3D%3D;
+        path=/; secure
+      - _mailapp_session=BAh7B0kiD3Nlc3Npb25faWQGOgZFVEkiJTBmZjA3OTJlYmZiZDRlMmZiMDRhOWE1Njk4OGI4N2E5BjsAVEkiEF9jc3JmX3Rva2VuBjsARkkiMTRINmxDOWFwQXNuanpOUTJ3S3YrWUx0SUdlOGFtYTc3LzJtVkJ1UytEaU09BjsARg%3D%3D--302b98f5ac8e3011ce838971d06f91655aee9c57;
+        path=/; secure; HttpOnly
+      X-Request-Id:
+      - 9d124ca6-8fa0-4af7-8eb6-e9de81fdf524
+      X-Runtime:
+      - '0.045639'
+      Vary:
+      - Accept-Encoding, Origin
+      Transfer-Encoding:
+      - chunked
+      Via:
+      - 1.1 vegur
+    body:
+      encoding: ASCII-8BIT
+      string: '{"name":"","primary_email_address":"email@example.com"}'
+    http_version: 
+  recorded_at: Wed, 17 Jan 2018 09:10:12 GMT
+recorded_with: VCR 3.0.3

data/fixtures/vcr_cassettes/add_subscriber_to_form.yml

@@ -0,0 +1,63 @@
+---
+http_interactions:
+- request:
+    method: post
+    uri: https://api.convertkit.com/v3/forms/175221/subscribe?api_key=<API_KEY>&api_secret=<API_SECRET>&email=test@example.com&fields&first_name&tags
+    body:
+      encoding: UTF-8
+      string: ''
+    headers:
+      User-Agent:
+      - Convertkit-Ruby v0.0.2
+      Content-Type:
+      - application/vnd.api+json
+      Accept:
+      - "*/*"
+      Content-Length:
+      - '0'
+      Accept-Encoding:
+      - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Server:
+      - Cowboy
+      Connection:
+      - keep-alive
+      Strict-Transport-Security:
+      - max-age=31536000
+      Content-Type:
+      - application/json; charset=utf-8
+      X-Ua-Compatible:
+      - IE=Edge,chrome=1
+      Etag:
+      - '"6f4dadc87b9a387093acd852dea9618e"'
+      Cache-Control:
+      - max-age=0, private, must-revalidate
+      Set-Cookie:
+      - XSRF-TOKEN=0SJZ0xaPTqHyg18%2BKQTSzc8d06nLQ52PAA8CJFnNGYjPxXvaO4%2FiRw1h%2BJy1Mqg3fLc1KeCNh7WK9wi7D%2BTZoQ%3D%3D;
+        path=/; secure
+      - _mailapp_session=BAh7BzoQX2NzcmZfdG9rZW5JIjFIdWNpQ1MwQXJPYi80cWVpbkRaNityT3E1b0FyemhvNml2Z0tuMVlwd0NrPQY6BkVGSSIPc2Vzc2lvbl9pZAY7BlRJIiViMGU3ZWUxNWM4Y2JkOTA5MDE4MGIzNzc3ZTRkNjE4ZQY7BlQ%3D--af4cf7b866ea64b704d0265f67773beb6a442f1e;
+        path=/; secure; HttpOnly
+      X-Request-Id:
+      - 581c1b56-1f79-4f3e-941b-821ce66ede3e
+      X-Runtime:
+      - '0.239698'
+      Vary:
+      - Accept-Encoding, Origin
+      Date:
+      - Tue, 28 Feb 2017 01:56:05 GMT
+      X-Rack-Cache:
+      - invalidate, pass
+      Transfer-Encoding:
+      - chunked
+      Via:
+      - 1.1 vegur
+    body:
+      encoding: ASCII-8BIT
+      string: '{"subscription":{"id":376449416,"state":"inactive","created_at":"2017-02-28T01:56:05Z","source":null,"referrer":null,"subscribable_id":175221,"subscribable_type":"form","subscriber":{"id":92766417,"first_name":null,"email_address":"test@example.com","state":"inactive","created_at":"2017-02-28T01:56:05Z","fields":{}}}}'
+    http_version: 
+  recorded_at: Tue, 28 Feb 2017 01:56:05 GMT
+recorded_with: VCR 3.0.3

data/fixtures/vcr_cassettes/delete_custom_field.yml

@@ -0,0 +1,57 @@
+---
+http_interactions:
+- request:
+    method: delete
+    uri: https://api.convertkit.com/v3/custom_fields/11176?api_key=<API_KEY>&api_secret=<API_SECRET>
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      User-Agent:
+      - Convertkit-Ruby v0.0.2
+      Content-Type:
+      - application/vnd.api+json
+      Accept:
+      - "*/*"
+      Accept-Encoding:
+      - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
+  response:
+    status:
+      code: 204
+      message: No Content
+    headers:
+      Server:
+      - Cowboy
+      Content-Length:
+      - '0'
+      Connection:
+      - keep-alive
+      Strict-Transport-Security:
+      - max-age=31536000
+      X-Ua-Compatible:
+      - IE=Edge,chrome=1
+      Cache-Control:
+      - no-cache, no-transform
+      Set-Cookie:
+      - XSRF-TOKEN=fmDy%2Fft9G%2F27ou%2Bhv1ImZi1kMJKcG5Vy69Hn5%2BlLnf0%2F1DZe%2FiWYEK8teH0uzhrMOmLCLqVvUCtiW1OfX%2BuFpw%3D%3D;
+        path=/; secure
+      - _mailapp_session=BAh7BzoQX2NzcmZfdG9rZW5JIjFRYlRFb3dWWWcrMFVqNWZja1p3OHFoY0c4cnc1ZE1WWmlZcTBlTGFnR0ZvPQY6BkVGSSIPc2Vzc2lvbl9pZAY7BlRJIiUzMWU1YzVmNjhkM2U1MDI5NjhmN2VhODQ2Mjc4OGVlOQY7BlQ%3D--352d4b2c54243bc8ee9def05694b6eb8bc799561;
+        path=/; secure; HttpOnly
+      X-Request-Id:
+      - 2660d874-056f-4c6d-af0b-8e51a2f8436f
+      X-Runtime:
+      - '0.070583'
+      Date:
+      - Fri, 03 Mar 2017 01:30:58 GMT
+      X-Rack-Cache:
+      - invalidate, pass
+      Vary:
+      - Origin
+      Via:
+      - 1.1 vegur
+    body:
+      encoding: UTF-8
+      string: ''
+    http_version: 
+  recorded_at: Fri, 03 Mar 2017 01:30:58 GMT
+recorded_with: VCR 3.0.3

data/fixtures/vcr_cassettes/forms.yml

@@ -0,0 +1,64 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: https://api.convertkit.com/v3/forms?api_key=<API_KEY>&api_secret=<API_SECRET>
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      User-Agent:
+      - Convertkit-Ruby v0.0.2
+      Content-Type:
+      - application/vnd.api+json
+      Accept:
+      - "*/*"
+      Accept-Encoding:
+      - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Server:
+      - Cowboy
+      Connection:
+      - keep-alive
+      Strict-Transport-Security:
+      - max-age=31536000
+      Content-Type:
+      - application/json; charset=utf-8
+      X-Ua-Compatible:
+      - IE=Edge,chrome=1
+      Etag:
+      - '"2d9600a1c415ac1e19ee2465fe41e8cc"'
+      Cache-Control:
+      - max-age=0, private, must-revalidate
+      Set-Cookie:
+      - XSRF-TOKEN=a1hcmaYVulN4QDrGoRSz6Y51cfjXMdmyJ66kyX3dPECeDZnhdd9AOW%2BBSwx3ppH5jwi4MQ%2FuR5kIfxCRlDy8dg%3D%3D;
+        path=/; secure
+      - _mailapp_session=BAh7B0kiD3Nlc3Npb25faWQGOgZFVEkiJTMwYzJkNTcxMWViZjNhMmVjYTIxZjI0NDE0NGZiYjY2BjsAVEkiEF9jc3JmX3Rva2VuBjsARkkiMTlWWEZlTlBLK21vWHdYSEsxcklpRUFGOXljblkzNTRyTDlHMFdPbmhnRFk9BjsARg%3D%3D--f0567bcf5195953cceab58959153298cdae4426b;
+        path=/; secure; HttpOnly
+      X-Request-Id:
+      - 6816358f-f95d-4374-ada6-9afe67a9717b
+      X-Runtime:
+      - '0.022329'
+      Vary:
+      - Accept-Encoding, Origin
+      Date:
+      - Fri, 02 Dec 2016 22:20:57 GMT
+      X-Rack-Cache:
+      - miss
+      Transfer-Encoding:
+      - chunked
+      Via:
+      - 1.1 vegur
+    body:
+      encoding: ASCII-8BIT
+      string: '{"forms":[{"id":133233,"name":"Did you like this post","created_at":"2016-12-01T17:25:23Z","type":"embed","url":"https://app.convertkit.com/landing_pages/133233","embed_js":"https://api.convertkit.com/v3/forms/133233.js?api_key=<API_KEY>","embed_url":"https://api.convertkit.com/v3/forms/133233.html?api_key=<API_KEY>","title":"Did
+        you like this post?","description":"\u003Cp\u003ESubscribe to my newsletter
+        and start every week with a new interesting post! \u003C/p\u003E","sign_up_button_text":"Subscribe","success_message":"Success!
+        Now check your email to confirm your subscription."}]}'
+    http_version: 
+  recorded_at: Fri, 02 Dec 2016 22:21:29 GMT
+recorded_with: VCR 3.0.3

data/fixtures/vcr_cassettes/get_custom_fields.yml

@@ -0,0 +1,62 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: https://api.convertkit.com/v3/custom_fields?api_key=<API_KEY>&api_secret=<API_SECRET>
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      User-Agent:
+      - Convertkit-Ruby v0.0.2
+      Content-Type:
+      - application/vnd.api+json
+      Accept:
+      - "*/*"
+      Accept-Encoding:
+      - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Server:
+      - Cowboy
+      Connection:
+      - keep-alive
+      Strict-Transport-Security:
+      - max-age=31536000
+      Content-Type:
+      - application/json; charset=utf-8
+      X-Ua-Compatible:
+      - IE=Edge,chrome=1
+      Etag:
+      - '"347787094aacea2ed1f0bc87551ec42e"'
+      Cache-Control:
+      - max-age=0, private, must-revalidate
+      Set-Cookie:
+      - XSRF-TOKEN=3%2F4ZwCDq72351KoSaKy5mRS87oiJTV4PCXk5uManqokO9Ej8zQUv4E2vXbPueOaKlRqs9cFcadHV0lqcfUC8dg%3D%3D;
+        path=/; secure
+      - _mailapp_session=BAh7B0kiD3Nlc3Npb25faWQGOgZFVEkiJTFjMzc4N2Y5M2YwZGVmZGExYTQ0YjBjYThmMWE1YWU5BjsAVEkiEF9jc3JmX3Rva2VuBjsARkkiMTBRcFJQTzN2d0kyMGUvZWhodFJmRTRHbVFuMUlFVGZlM0t0akpMdm5Gdjg9BjsARg%3D%3D--4ce462d08e77f8371cb3895c4f85c8425d210525;
+        path=/; secure; HttpOnly
+      X-Request-Id:
+      - 56645fe1-1737-4648-beaa-0b374aa5bb0c
+      X-Runtime:
+      - '0.075874'
+      Vary:
+      - Accept-Encoding, Origin
+      Date:
+      - Fri, 03 Mar 2017 01:05:50 GMT
+      X-Rack-Cache:
+      - miss
+      Transfer-Encoding:
+      - chunked
+      Via:
+      - 1.1 vegur
+    body:
+      encoding: ASCII-8BIT
+      string: '{"custom_fields":[{"id":11174,"name":"ck_field_11174_phone_number","key":"phone_number","label":"Phone
+        Number"}]}'
+    http_version: 
+  recorded_at: Fri, 03 Mar 2017 01:05:51 GMT
+recorded_with: VCR 3.0.3

data/fixtures/vcr_cassettes/new_custom_field.yml

@@ -0,0 +1,65 @@
+---
+http_interactions:
+- request:
+    method: post
+    uri: https://api.convertkit.com/v3/custom_fields?api_key=<API_KEY>&api_secret=<API_SECRET>&label=Occupation
+    body:
+      encoding: UTF-8
+      string: ''
+    headers:
+      User-Agent:
+      - Convertkit-Ruby v0.0.2
+      Content-Type:
+      - application/vnd.api+json
+      Accept:
+      - "*/*"
+      Content-Length:
+      - '0'
+      Accept-Encoding:
+      - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
+  response:
+    status:
+      code: 201
+      message: Created
+    headers:
+      Server:
+      - Cowboy
+      Connection:
+      - keep-alive
+      Strict-Transport-Security:
+      - max-age=31536000
+      Location:
+      - "/v3/custom_fields"
+      Content-Type:
+      - application/json; charset=utf-8
+      X-Ua-Compatible:
+      - IE=Edge,chrome=1
+      Etag:
+      - '"a28614c3d7734e0085a61cde2c07b05a"'
+      Cache-Control:
+      - max-age=0, private, must-revalidate
+      Set-Cookie:
+      - XSRF-TOKEN=pQN4%2BB%2FjHD4EqdFEpswxsF%2BnGsNfS%2FWTHnzKcnkOQSJucNwxsBRer4bXi%2Fm%2F%2FeMrg221XkmNeQ1%2Fn%2B2f9iLJIw%3D%3D;
+        path=/; secure
+      - _mailapp_session=BAh7BzoQX2NzcmZfdG9rZW5JIjF5M09reWEvM1FwR0NmbHE5R1RIU205ektyNTBXeG95ZVllTW43WThzaUFFPQY6BkVGSSIPc2Vzc2lvbl9pZAY7BlRJIiVmYTQzNTk1YjI3ZjcxMWU3ZGM4YjZiNTc1MzVjODMyYgY7BlQ%3D--c362e7889147cb4a77103b99cdc5721e88a12b30;
+        path=/; secure; HttpOnly
+      X-Request-Id:
+      - 2eef5bf1-8f2b-4a68-a157-0d7ccbef1012
+      X-Runtime:
+      - '0.073102'
+      Vary:
+      - Accept-Encoding, Origin
+      Date:
+      - Fri, 03 Mar 2017 01:22:53 GMT
+      X-Rack-Cache:
+      - invalidate, pass
+      Transfer-Encoding:
+      - chunked
+      Via:
+      - 1.1 vegur
+    body:
+      encoding: ASCII-8BIT
+      string: '{"account_id":26718,"created_at":"2017-03-03T01:22:53Z","id":11176,"key":"occupation","kind":null,"label":"Occupation","updated_at":"2017-03-03T01:22:53Z","name":"ck_field_11176_occupation","value":null}'
+    http_version: 
+  recorded_at: Fri, 03 Mar 2017 01:22:53 GMT
+recorded_with: VCR 3.0.3

data/fixtures/vcr_cassettes/update_custom_field.yml

@@ -0,0 +1,59 @@
+---
+http_interactions:
+- request:
+    method: put
+    uri: https://api.convertkit.com/v3/custom_fields/11184?api_key=<API_KEY>&api_secret=<API_SECRET>&label=Discount%20Code
+    body:
+      encoding: UTF-8
+      string: ''
+    headers:
+      User-Agent:
+      - Convertkit-Ruby v0.0.2
+      Content-Type:
+      - application/vnd.api+json
+      Accept:
+      - "*/*"
+      Content-Length:
+      - '0'
+      Accept-Encoding:
+      - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
+  response:
+    status:
+      code: 204
+      message: No Content
+    headers:
+      Server:
+      - Cowboy
+      Content-Length:
+      - '0'
+      Connection:
+      - keep-alive
+      Strict-Transport-Security:
+      - max-age=31536000
+      X-Ua-Compatible:
+      - IE=Edge,chrome=1
+      Cache-Control:
+      - no-cache, no-transform
+      Set-Cookie:
+      - XSRF-TOKEN=KHxmbTwPv230b%2FnQnhMO22pGqNhCPcksnKcn8HEx6KbM%2FH8V8aSKk25Y%2BZgzkACvJUasYJYWXYqihd2OsUBYRg%3D%3D;
+        path=/; secure
+      - _mailapp_session=BAh7BzoQX2NzcmZfdG9rZW5JIjE1SUFaZU0yck5mNmFOd0JJcllNT2RFOEFCTGpVSzVTbVBpTDZmc0J4c09BPQY6BkVGSSIPc2Vzc2lvbl9pZAY7BlRJIiVkN2NlZmE3M2ZlYjZjOTNjNWY3NTY3ZDc5ZWYzMzliYwY7BlQ%3D--c7d09be19409ef827cd003f03a056e4f374da37c;
+        path=/; secure; HttpOnly
+      X-Request-Id:
+      - 2b8dc9b0-69ef-4c7d-bfaf-1b47ca740e09
+      X-Runtime:
+      - '0.156904'
+      Date:
+      - Fri, 03 Mar 2017 01:41:15 GMT
+      X-Rack-Cache:
+      - invalidate, pass
+      Vary:
+      - Origin
+      Via:
+      - 1.1 vegur
+    body:
+      encoding: UTF-8
+      string: ''
+    http_version: 
+  recorded_at: Fri, 03 Mar 2017 01:41:15 GMT
+recorded_with: VCR 3.0.3

data/lib/convertkit.rb

@@ -0,0 +1,17 @@
+require "convertkit/version"
+require "convertkit/configuration"
+require "convertkit/client"
+
+module Convertkit
+  class << self
+    attr_accessor :configuration
+  end
+
+  def self.configuration
+    @configuration ||= Configuration.new
+  end
+
+  def self.configure
+    yield(configuration)
+  end
+end

data/lib/convertkit/client.rb

@@ -0,0 +1,31 @@
+require "convertkit/client/account"
+require "convertkit/client/custom_fields"
+require "convertkit/client/forms"
+require "convertkit/client/sequences"
+require "convertkit/client/subscribers"
+require "convertkit/client/webhooks"
+require "convertkit/client/tags"
+require "convertkit/connection"
+
+module Convertkit
+  class Client
+    include Account
+    include CustomFields
+    include Forms
+    include Sequences
+    include Subscribers
+    include Webhooks
+    include Tags
+
+    attr_accessor :api_secret, :api_key
+
+    def initialize( api_key=nil, api_secret=nil )
+      @api_secret = api_secret || Convertkit.configuration.api_secret
+      @api_key = api_key || Convertkit.configuration.api_key
+    end
+
+    def connection
+      @connection ||= Connection.new(api_key: api_key, api_secret: api_secret)
+    end
+  end
+end

data/lib/convertkit/client/account.rb

@@ -0,0 +1,9 @@
+module Convertkit
+  class Client
+    module Account
+      def account
+        connection.get("account").body
+      end
+    end
+  end
+end

data/lib/convertkit/client/custom_fields.rb

@@ -0,0 +1,27 @@
+module Convertkit
+  class Client
+    module CustomFields
+
+      def custom_fields
+        connection.get("custom_fields").body["custom_fields"]
+      end
+
+      def add_custom_field(options = {})
+        connection.post("custom_fields") do |f|
+          f.params['label'] = options[:label]
+        end
+      end
+
+      def delete_custom_field(custom_field_id)
+        connection.delete("custom_fields/#{custom_field_id}")
+      end
+
+      def update_custom_field(custom_field_id, options = {})
+        connection.put("custom_fields/#{custom_field_id}") do |f|
+          f.params['label'] = options[:label]
+        end
+      end
+
+    end
+  end
+end

data/lib/convertkit/client/forms.rb

@@ -0,0 +1,18 @@
+module Convertkit
+  class Client
+    module Forms
+      def forms
+        connection.get("forms").body["forms"]
+      end
+
+      def add_subscriber_to_form(form_id, email, options = {})
+        connection.post("forms/#{form_id}/subscribe") do |f|
+          f.params['email'] = email
+          f.params['first_name'] = options[:first_name]
+          f.params['fields'] = options[:fields]
+          f.params['tags'] = options[:tags]
+        end
+      end
+    end
+  end
+end

data/lib/convertkit/client/sequences.rb

@@ -0,0 +1,18 @@
+module Convertkit
+  class Client
+    module Sequences
+      def sequences
+        connection.get("sequences")
+      end
+
+      def add_subscriber_to_sequence(sequence_id, email, options = {})
+        connection.post("sequences/#{sequence_id}/subscribe") do |f|
+          f.params['email'] = email
+          f.params['first_name'] = options[:first_name]
+          f.params['fields'] = options[:fields]
+          f.params['tags'] = options[:tags]
+        end
+      end
+    end
+  end
+end

data/lib/convertkit/client/subscribers.rb

@@ -0,0 +1,36 @@
+module Convertkit
+  class Client
+    module Subscribers
+      def subscribers(options = {})
+        connection.get("subscribers", options)
+      end
+
+      def subscriber(subscriber_id)
+        connection.get("subscribers/#{subscriber_id}")
+      end
+
+      def subscriber_tags(subscriber_id)
+        connection.get("subscribers/#{subscriber_id}/tags")
+      end
+
+      def update_subscriber(subscriber_id, options = {})
+        response = connection.put("subscribers/#{subscriber_id}") do |f|
+          f.params["email_address"] = options[:email_address] if options[:email_address]
+          f.params["fields"] = options[:fields] if options[:fields]
+          f.params["first_name"] = options[:first_name] if options[:first_name]
+        end
+        response.body
+      end
+
+      def unsubscribe(email)
+        connection.put("unsubscribe") do |f|
+          f.params['email'] = email
+        end
+      end
+
+      def remove_tag_from_subscriber(subscriber_id, tag_id)
+        connection.delete("subscribers/#{subscriber_id}/tags/#{tag_id}")
+      end
+    end
+  end
+end

data/lib/convertkit/client/tags.rb

@@ -0,0 +1,49 @@
+module Convertkit
+  class Client
+    module Tags
+      def tags
+        connection.get("tags")
+      end
+
+      def add_subscriber_to_tag(tag_id, email, options = {})
+        connection.post("tags/#{tag_id}/subscribe") do |f|
+          f.params['email'] = email
+          f.params['first_name'] = options[:first_name]
+          f.params['fields'] = options[:fields]
+          f.params['tags'] = options[:tags]
+        end
+      end
+
+      def remove_tag_from_subscriber(tag_id, subscriber_id)
+        connection.delete("subscribers/#{subscriber_id}/tags/#{tag_id}")
+      end
+
+      def remove_tag_from_subscriber_by_email(tag_id, email)
+        connection.post("tags/#{tag_id}/unsubscribe") do |f|
+          f.params['email'] = email
+        end
+      end
+
+      def create_tag(tag_name)
+        response = connection.post("tags") do |request|
+          request.params["tag"] = { name: tag_name }
+        end
+        response.body
+      end
+
+      def create_tags(tag_names)
+        response = connection.post("tags") do |request|
+          request.params["tag"] = tag_names.map { |tag_name| { name: tag_name } }
+        end
+        response.body
+      end
+
+      def subscriptions_to_tag(tag_id, options = {})
+        connection.get("tags/#{tag_id}/subscriptions", options) do |f|
+          f.params["sort_order"] = options[:sort_order] if options[:sort_order]
+          f.params["subscriber_state"] = options[:subscriber_state] if options[:subscriber_state]
+        end
+      end
+    end
+  end
+end

data/lib/convertkit/client/webhooks.rb

@@ -0,0 +1,17 @@
+module Convertkit
+  class Client
+    module Webhooks
+      def create_webhook(url, events)
+        response = connection.post("automations/hooks") do |f|
+          f.params['target_url'] = url
+          f.params['event'] = events
+        end
+        response.body
+      end
+
+      def remove_webhook(rule_id)
+        connection.delete("automations/hooks/#{rule_id}").body
+      end
+    end
+  end
+end

data/lib/convertkit/configuration.rb

@@ -0,0 +1,11 @@
+module Convertkit
+  class Configuration
+    attr_accessor :api_secret, :api_key
+    attr_accessor :timeout, :open_timeout
+
+    def initialize
+      @timeout = 30
+      @open_timeout = 5
+    end
+  end
+end

data/lib/convertkit/connection.rb

@@ -0,0 +1,86 @@
+require "convertkit/errors"
+require "faraday"
+require "faraday_middleware"
+require "json"
+
+module Convertkit
+  class Connection
+    attr_reader :http_connection
+
+    def initialize(api_key: nil, api_secret: nil)
+      @http_connection = faraday_connection(api_key, api_secret)
+    end
+
+    def content_type
+      "application/vnd.api+json"
+    end
+
+    def get(*args, &blk)
+      request(:get, *args, &blk)
+    end
+
+    def post(*args, &blk)
+      request(:post, *args, &blk)
+    end
+
+    def put(*args, &blk)
+      request(:put, *args, &blk)
+    end
+
+    def delete(*args, &blk)
+      request(:delete, *args, &blk)
+    end
+
+    private
+
+    def faraday_connection(api_key, api_secret)
+      Faraday.new do |f|
+        f.url_prefix = "https://api.convertkit.com/v3/"
+        f.adapter :net_http
+
+        f.options.timeout = Convertkit.configuration.timeout
+        f.options.open_timeout = Convertkit.configuration.open_timeout
+
+        f.headers['User-Agent'] = "Convertkit-Ruby v#{Convertkit::VERSION}"
+        f.headers['Content-Type'] = content_type
+        f.headers['Accept'] = "*/*"
+
+        f.params['api_secret'] = api_secret if api_secret
+        f.params['api_key'] = api_key if api_key
+
+        f.response :json, content_type: /\bjson$/
+      end
+    end
+
+    def request(method, *args, &blk)
+      begin
+        response = http_connection.public_send(method, *args, &blk)
+      rescue Faraday::Error => e
+        raise ConnectionError.new(e)
+      end
+
+      unless response.success?
+        handle_error_response(response)
+      end
+
+      response
+    end
+
+    def handle_error_response(response)
+      case response.status
+      when 401
+        raise AuthorizationError.new(response.body)
+      when 404
+        raise NotFoundError.new(response.body)
+      when 422
+        raise UnprocessableEntityError.new(response.body)
+      when 429
+        raise TooManyRequestsError.new(response.body)
+      when 500..599
+        raise ServerError.new(response.body)
+      else
+        raise UnknownError.new(response.body)
+      end
+    end
+  end
+end

data/lib/convertkit/errors.rb

@@ -0,0 +1,11 @@
+module Convertkit
+  class Error < StandardError; end
+
+  class AuthorizationError < Error; end
+  class ConnectionError < Error; end
+  class NotFoundError < Error; end
+  class ServerError < Error; end
+  class TooManyRequestsError < Error; end
+  class UnknownError < Error; end
+  class UnprocessableEntityError < Error; end
+end

data/lib/convertkit/version.rb

@@ -0,0 +1,3 @@
+module Convertkit
+  VERSION = "0.0.5"
+end

metadata

@@ -0,0 +1,176 @@
+--- !ruby/object:Gem::Specification
+name: convertkit-ruby
+version: !ruby/object:Gem::Version
+  version: 0.0.5
+platform: ruby
+authors:
+- Raymond Cudjoe
+- Hook Engine
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2020-08-15 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  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: 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: dotenv
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: faraday_middleware
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.8.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.8.3
+description: A simple wrapper for the ConvertKit API
+email:
+- rkcudjoe@gmail.com
+- rkcudjoe@hookengine.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".github/workflows/ruby.yml"
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- convertkit-ruby.gemspec
+- fixtures/vcr_cassettes/account.yml
+- fixtures/vcr_cassettes/add_subscriber_to_form.yml
+- fixtures/vcr_cassettes/delete_custom_field.yml
+- fixtures/vcr_cassettes/forms.yml
+- fixtures/vcr_cassettes/get_custom_fields.yml
+- fixtures/vcr_cassettes/new_custom_field.yml
+- fixtures/vcr_cassettes/update_custom_field.yml
+- lib/convertkit.rb
+- lib/convertkit/client.rb
+- lib/convertkit/client/account.rb
+- lib/convertkit/client/custom_fields.rb
+- lib/convertkit/client/forms.rb
+- lib/convertkit/client/sequences.rb
+- lib/convertkit/client/subscribers.rb
+- lib/convertkit/client/tags.rb
+- lib/convertkit/client/webhooks.rb
+- lib/convertkit/configuration.rb
+- lib/convertkit/connection.rb
+- lib/convertkit/errors.rb
+- lib/convertkit/version.rb
+homepage: http://hookengine.com
+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: []
+rubygems_version: 3.0.0
+signing_key: 
+specification_version: 4
+summary: A Ruby gem for interacting with the ConvertKit API v3
+test_files: []