active-campaign-simple 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: e985487ca78df3e1c59d3ab2797a88b166c84a05f4624e22584827619ff531c6
+  data.tar.gz: 6bd4487f7ec7b4056c721d01f2d7e74bb069ffc53fc130915bd9cd9db9c3deb3
+SHA512:
+  metadata.gz: 7816983565ec399b90bb211f551ac7a5d3ca43519dc00c98b6958fc93e184fd22d3b7cfdcc9eedcc3757bed63fbc1000183079c8f18b0577ee5a1d4302bd8f7b
+  data.tar.gz: d916285c529751f1636e3225958f4f09cb162f4ebd6ae0b0ef5471b0a3899137776a8da748682b82097357e808bf1e4e1ae04be07a6b758f3dd84b672769a2f7

data/.gitignore

@@ -0,0 +1,56 @@
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/spec/examples.txt
+/test/tmp/
+/test/version_tmp/
+/tmp/
+
+# Used by dotenv library to load environment variables.
+# .env
+
+# Ignore Byebug command history file.
+.byebug_history
+
+## Specific to RubyMotion:
+.dat*
+.repl_history
+build/
+*.bridgesupport
+build-iPhoneOS/
+build-iPhoneSimulator/
+
+## Specific to RubyMotion (use of CocoaPods):
+#
+# We recommend against adding the Pods directory to your .gitignore. However
+# you should judge for yourself, the pros and cons are mentioned at:
+# https://guides.cocoapods.org/using/using-cocoapods.html#should-i-check-the-pods-directory-into-source-control
+#
+# vendor/Pods/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalization:
+/.bundle/
+/vendor/bundle
+/lib/bundler/man/
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+# Gemfile.lock
+# .ruby-version
+# .ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc
+
+# Used by RuboCop. Remote config files pulled in from inherit_from directive.
+# .rubocop-https?--*

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2021 nateleavitt
+
+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,79 @@
+# active-campaign-simple
+Simple Ruby REST wrapper for the Active Campaign API
+
+
+## <a name="info">Info</a>
+This is a very simple wrapper around the REST ActiveCampaign API. You will still need to provide the path and the payload for each request. Eventually I will grow this out to be more convenient. Right now this just provides some conveniences and an easy way to configure the API and not much more... hence the name active-campaign-simple :)
+
+Use the public API as a guide for paths (urls) and payload info: https://developers.activecampaign.com/
+
+## <a name="installation">Installation</a>
+`gem install active-campaign-simple`
+
+## <a name="setup">Config</a>
+1. add `gem 'active-campaign-simple'` to your `Gemfile`
+2. Get your API URL and Key from within your application (Settings > Developer)
+3. Then create an initializer in `config\initializers` called active_campaign.rb and the following
+
+```ruby
+# Added to your config\initializers file
+ActiveCampaign.configure do |config|
+  config.api_url = 'YOUR_API_URL'
+  config.api_key = 'YOUR_API_KEY'
+  config.api_logger = Logger.new("#{Rails.root}/log/active_campaign_api.log") # optional logger file
+end
+```
+
+## <a name="examples">Examples</a>
+
+```ruby
+# Get a list of contacts
+ActiveCampaign.get('/contacts')
+
+# Get a contact
+ActiveCampaign.get('/contacts' + id)
+
+# Create a new contact
+# https://developers.activecampaign.com/reference#create-a-contact-new
+payload = {
+  contact: {
+    email: 'nate@test.com',
+    firstName: 'Nate',
+    lastName: 'Test',
+    phone: '1231231234'
+  },
+  fieldValues: {
+    {
+      field: '1',
+      value: 'The Value for First Field'
+    },
+    {
+      field: '6',
+      value: '2008-01-20'
+    }
+  }
+}
+ActiveCampaign.post('/contacts', payload: payload)
+
+# Update a contact
+payload = {
+  contact: {
+    email: 'nate@test.com',
+  },
+  fieldValues: {
+    {
+      field: '1',
+      value: 'The Value for First Field'
+    },
+  }
+}
+ActiveCampaign.post('/contacts' + id, payload: payload)
+
+# Delete a contact
+ActiveCampaign.delete('/contacts' + id)
+```
+
+## <a name="contributing">Contributing</a>
+In the spirit of [free software](http://www.fsf.org/licensing/essays/free-sw.html), **everyone** is encouraged to help improve this project.
+
+See [MIT LICENSE](https://github.com/nateleavitt/active-campaign-simple/blob/master/LICENSE.md) for details.

data/active-campaign-simple.gemspec

@@ -0,0 +1,21 @@
+# encoding: utf-8
+require File.expand_path('../lib/active-campaign-simple/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.name = 'active-campaign-simple'
+  gem.summary = %q{Simple Ruby REST wrapper for the ActiveCampaign API}
+  gem.description = 'Simple Ruby REST wrapper for the ActiveCampaign'
+  gem.authors = ["Nathan Leavitt"]
+  gem.email = ['nateleavitt@gmail.com']
+  gem.license = 'MIT'
+  # gem.executables = `git ls-files -- bin/*`.split("\n").map{|f| File.basename(f)}
+  gem.files = `git ls-files`.split("\n")
+  gem.homepage = 'https://github.com/nateleavitt/active-campaign-simple'
+  gem.require_paths = ['lib']
+  gem.required_rubygems_version = Gem::Requirement.new('>= 3.0.0')
+
+  gem.add_development_dependency 'rake', '~> 13.0'
+  gem.add_dependency 'rest-client', '~> 2.1'
+
+  gem.version = ActiveCampaign::VERSION.dup
+end

data/lib/active-campaign-simple/client.rb

@@ -0,0 +1,21 @@
+require 'active-campaign-simple/config'
+require 'active-campaign-simple/request'
+
+module ActiveCampaign
+
+  class Client
+    include Request
+
+    # attr_accessor :retry_count
+    attr_accessor *Config::VALID_OPTION_KEYS
+
+    def initialize(options={})
+      options = ActiveCampaign.options.merge(options)
+      Config::VALID_OPTION_KEYS.each do |key|
+        send("#{key}=", options[key])
+      end
+    end
+
+  end
+
+end

data/lib/active-campaign-simple/config.rb

@@ -0,0 +1,38 @@
+require 'active-campaign-simple/version'
+
+module ActiveCampaign
+
+  module Config
+    # The list of available options
+    VALID_OPTION_KEYS = [
+      :api_url,
+      :api_key,
+      :api_logger,
+      :user_agent # allows you to change the User-Agent of the request headers
+    ].freeze
+
+    # @private
+    attr_accessor *VALID_OPTION_KEYS
+
+    # Convenience method to allow configuration options to be set in a block
+    def configure
+      yield self
+    end
+
+    # Create a hash of options and their values
+    def options
+      options = {}
+      VALID_OPTION_KEYS.each{|k| options[k] = send(k)}
+      options
+    end
+
+    def user_agent
+      @user_agent ||= "active-campaign-simple-#{VERSION} (RubyGem)"
+    end
+
+    def api_logger
+      @api_logger || ActiveCampaign::Logger.new
+    end
+  end
+
+end

data/lib/active-campaign-simple/logger.rb

@@ -0,0 +1,14 @@
+module ActiveCampaign
+  class Logger
+
+    def info(msg); $stdout.puts msg end
+
+    def warn(msg); $stdout.puts msg end
+
+    def error(msg); $stdout.puts msg end
+
+    def debug(msg); $stdout.puts msg end
+
+    def fatal(msg); $stdout.puts msg end
+  end
+end

data/lib/active-campaign-simple/request.rb

@@ -0,0 +1,53 @@
+require 'rest-client'
+
+module ActiveCampaign
+  module Request
+    # Perform an GET request
+    def get(path)
+      request(:get, path)
+    end
+
+    # Perform an HTTP POST request
+    def post(path, payload: {})
+      request(:post, path, payload)
+    end
+
+    # Perform an HTTP PUT request
+    def put(path, payload: {})
+      request(:put, path, payload)
+    end
+
+    # Perform an HTTP PATCH request
+    def patch(path, payload: {})
+      request(:patch, path, payload)
+    end
+
+    # Perform an HTTP DELETE request
+    def delete(path)
+      request(:delete, path)
+    end
+
+    private
+
+    # Perform request
+    def request(method, path, payload={})
+      path = "/#{path}" unless path.start_with?('/')
+      header = {
+        'Api-Token': api_key,
+        content_type: :json,
+        accept: :json,
+      }
+      opts = {
+        method: method,
+        url: api_url + '/api/3' + path,
+        headers: header
+      }
+      opts.merge!( { payload: payload.to_json }) unless payload.empty?
+      resp = RestClient::Request.execute(opts)
+    rescue RestClient::ExceptionWithResponse => err
+      # log error?
+    else
+      return JSON.parse(resp.body) if resp.body # Some calls respond w nothing
+    end
+  end
+end

data/lib/active-campaign-simple/version.rb

@@ -0,0 +1,4 @@
+module ActiveCampaign
+  # The version of the gem
+  VERSION = '0.1.0'.freeze unless defined?(::ActiveCampaign::VERSION)
+end

data/lib/active-campaign-simple.rb

@@ -0,0 +1,25 @@
+require 'active-campaign-simple/client'
+require 'active-campaign-simple/config'
+require 'active-campaign-simple/logger'
+
+module ActiveCampaign
+  extend Config
+  class << self
+    # Alias for ActiveCampaign::Client.new
+    #
+    # @return [ActiveCampaign::Client]
+    def new(options={})
+      ActiveCampaign::Client.new(options)
+    end
+
+    # Delegate to ActiveCampaign::Client
+    def method_missing(method, *args, **kwargs)
+      return super unless new.respond_to?(method)
+      new.send(method, *args, **kwargs)
+    end
+
+    def respond_to?(method, include_private = false)
+      new.respond_to?(method, include_private) || super(method, include_private)
+    end
+  end
+end

metadata

@@ -0,0 +1,82 @@
+--- !ruby/object:Gem::Specification
+name: active-campaign-simple
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Nathan Leavitt
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2021-09-09 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+- !ruby/object:Gem::Dependency
+  name: rest-client
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+description: Simple Ruby REST wrapper for the ActiveCampaign
+email:
+- nateleavitt@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE
+- README.md
+- active-campaign-simple.gemspec
+- lib/active-campaign-simple.rb
+- lib/active-campaign-simple/client.rb
+- lib/active-campaign-simple/config.rb
+- lib/active-campaign-simple/logger.rb
+- lib/active-campaign-simple/request.rb
+- lib/active-campaign-simple/version.rb
+homepage: https://github.com/nateleavitt/active-campaign-simple
+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: 3.0.0
+requirements: []
+rubygems_version: 3.2.15
+signing_key:
+specification_version: 4
+summary: Simple Ruby REST wrapper for the ActiveCampaign API
+test_files: []