active_campaign_crm 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 3669481809ba5f04d81fc3964c2e92eb8fdc58d9f399534fc4a92bbbf8181d7c
+  data.tar.gz: 51af60ef17e611896ac61a96fbe741e54b6d1ce639c1968fe1a78fa974c61ba1
+SHA512:
+  metadata.gz: f5d81a854e9d01cc402242165c1767d5f333870ca89650a1e9305dad6638754a6bbca667df4a55d45ccff10e097ad73f727303e1f3dd3c7cd2107e130363cc23
+  data.tar.gz: 67dba6d05a8db13c5ef08149f83ea5f173c0b4e3feed741fc3976b1ef4caea57b4b5a98b40b17b651a0a891260bd9dd2f7682e88446f8a1ca25f5ae7d525cd8c

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,7 @@
+---
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.5.0
+before_install: gem install bundler -v 1.16.6

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 nunolopesrb@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 active_campaign_crm.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,39 @@
+PATH
+  remote: .
+  specs:
+    active_campaign_crm (0.1.0)
+      faraday (~> 0.15)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    diff-lcs (1.3)
+    faraday (0.15.4)
+      multipart-post (>= 1.2, < 3)
+    multipart-post (2.0.0)
+    rake (10.5.0)
+    rspec (3.8.0)
+      rspec-core (~> 3.8.0)
+      rspec-expectations (~> 3.8.0)
+      rspec-mocks (~> 3.8.0)
+    rspec-core (3.8.0)
+      rspec-support (~> 3.8.0)
+    rspec-expectations (3.8.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-mocks (3.8.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-support (3.8.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  active_campaign_crm!
+  bundler (~> 1.16)
+  rake (~> 10.0)
+  rspec (~> 3.0)
+
+BUNDLED WITH
+   1.16.6

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2019 Whitesmith
+
+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,40 @@
+# ActiveCampaignCrm
+A basic wrapper for active campaign
+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'active_campaign_crm'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install active_campaign_crm
+
+## Usage
+
+
+## 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/whitesmith/active_campaign_crm. 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](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the ActiveCampaignCrm project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/active_campaign_crm/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/active_campaign_crm.gemspec

@@ -0,0 +1,31 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "active_campaign_crm/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "active_campaign_crm"
+  spec.version       = ActiveCampaignCrm::VERSION
+  spec.authors       = ["Nuno Correia"]
+  spec.email         = ["nuno_lopes@whitesmith.co"]
+
+  spec.summary       = "A basic API wrapper for active campaign "
+  spec.description   = "A basic API wrapper for active campaign "
+  # spec.homepage      = "TODO: Put your gem's website or public repo URL here."
+  spec.license       = "MIT"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |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_dependency "faraday", "~> 0.15"
+
+  spec.add_development_dependency "bundler", "~> 1.16"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "active_campaign_crm"
+
+# 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(__FILE__)

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/active_campaign_crm/client/contact_fields.rb

@@ -0,0 +1,31 @@
+module ActiveCampaignCrm
+  class Client
+    module ContactFields
+      def contact_fields(params = {})
+        response = @connection.get('fields', params)
+        response['fields']
+      end
+
+      def contact_field(id)
+        response = @connection.get("fields/#{id}")
+        response['field']
+      end
+
+      def create_contact_field(properties)
+        @connection.post('fields', contact_field_body(properties))
+      end
+
+      def contact_field_body(properties)
+        { 'field': properties }.to_json
+      end
+
+      def update_contact_field(id, properties)
+        @connection.put("fields/#{id}", contact_field_body(properties))
+      end
+
+      def delete_contact_field(id)
+        @connection.delete("fields/#{id}")
+      end
+    end
+  end
+end

data/lib/active_campaign_crm/client/contacts.rb

@@ -0,0 +1,35 @@
+module ActiveCampaignCrm
+  class Client
+    module Contacts
+      def contacts(params = {})
+        response = @connection.get('contacts', params)
+        response['contacts']
+      end
+
+      def contact(id)
+        response = @connection.get("contacts/#{id}")
+        response['contact']
+      end
+
+      def create_contact(fields)
+        @connection.post('contacts', contact_body(fields))
+      end
+
+      def sync_contact(fields)
+        @connection.post('contact/sync', contact_body(fields))
+      end
+
+      def update_contact(id, fields)
+        @connection.put("contacts/#{id}", contact_body(fields))
+      end
+
+      def delete_contact(id)
+        @connection.delete("contacts/#{id}")
+      end
+
+      def contact_body(fields)
+        { 'contact': fields }.to_json
+      end
+    end
+  end
+end

data/lib/active_campaign_crm/client/custom_field_values.rb

@@ -0,0 +1,31 @@
+module ActiveCampaignCrm
+  class Client
+    module CustomFieldValues
+      def custom_field_values(params = {})
+        response = @connection.get('fieldValues', params)
+        response['fieldValues']
+      end
+
+      def custom_field_value(id)
+        response = @connection.get("fieldValues/#{id}")
+        response['fieldValue']
+      end
+
+      def create_custom_field_value(properties)
+        @connection.post('fieldValues', custom_field_value_body(properties))
+      end
+
+      def update_custom_field_value(id, properties)
+        @connection.put("fieldValues/#{id}", custom_field_value_body(properties))
+      end
+
+      def delete_custom_field_value(id)
+        @connection.delete("fieldValues/#{id}")
+      end
+
+      def custom_field_value_body(properties)
+        { 'fieldValue': properties }.to_json
+      end
+    end
+  end
+end

data/lib/active_campaign_crm/client/organizations.rb

@@ -0,0 +1,31 @@
+module ActiveCampaignCrm
+  class Client
+    module Organization
+      def organizations(params = {})
+        response = @connection.get('organizations', params)
+        response['organizations']
+      end
+
+      def organization(id)
+        response = @connection.get("organizations/#{id}")
+        response['organization']
+      end
+
+      def create_organization(fields)
+        @connection.post('organizations', organization_body(fields))
+      end
+
+      def update_organization(id, fields)
+        @connection.put("organizations/#{id}", organization_body(fields))
+      end
+
+      def delete_organization(id)
+        @connection.delete("organizations/#{id}")
+      end
+
+      def organization_body(fields)
+        { 'organization': fields }.to_json
+      end
+    end
+  end
+end

data/lib/active_campaign_crm/client/tags.rb

@@ -0,0 +1,44 @@
+module ActiveCampaignCrm
+  class Client
+    module Tags
+      def tags(params = {})
+        response = @connection.get('tags', params)
+        response['tags']
+      end
+
+      def tag(id)
+        response = @connection.get("tags/#{id}")
+        response['tag']
+      end
+
+      def create_tag(fields)
+        @connection.post('tags', tag_body(fields))
+      end
+
+      def add_tag_to_contact(contact, tag)
+        @connection.post('contactTags', contact_link_tag_body(contact, tag))
+      end
+
+      def update_tag(id, fields)
+        @connection.put("tags/#{id}", tag_body(fields))
+      end
+
+      def delete_tag(id)
+        @connection.delete("tags/#{id}")
+      end
+
+      def contact_link_tag_body(contact, tag)
+        {
+          'contactTag': {
+            'contact': contact,
+            'tag': tag
+          }
+        }.to_json
+      end
+
+      def tag_body(fields)
+        { 'tag': fields }.to_json
+      end
+    end
+  end
+end

data/lib/active_campaign_crm/client.rb

@@ -0,0 +1,17 @@
+module ActiveCampaignCrm
+  class Client
+    require 'active_campaign_crm/connection'
+
+    Dir[File.expand_path('../client/*.rb', __FILE__)].each{ |f| require f }
+
+    def initialize
+      @connection = ActiveCampaignCrm::Connection.new
+    end
+
+    include ActiveCampaignCrm::Client::Contacts
+    include ActiveCampaignCrm::Client::ContactFields
+    include ActiveCampaignCrm::Client::CustomFieldValues
+    include ActiveCampaignCrm::Client::Tags
+    include ActiveCampaignCrm::Client::Organization
+  end
+end

data/lib/active_campaign_crm/configuration.rb

@@ -0,0 +1,20 @@
+module ActiveCampaignCrm
+  class << self
+    attr_accessor :configuration
+  end
+
+  def self.configure
+    self.configuration ||= Configuration.new
+    yield(configuration)
+  end
+
+  class Configuration
+    attr_accessor :account_url
+    attr_accessor :api_key
+
+    def initialize
+      @account_url = nil
+      @api_key = nil
+    end
+  end
+end

data/lib/active_campaign_crm/connection.rb

@@ -0,0 +1,76 @@
+module ActiveCampaignCrm
+  class Connection
+    require 'faraday'
+    require 'json'
+    require 'active_campaign_crm/error'
+    def initialize
+      # TODO: raise exception if account_url is not defined
+      # TODO: raise exception if api_key is not defined
+      @connection = Faraday.new(
+        url: "#{ActiveCampaignCrm.configuration.account_url}/api/3"
+      )
+    end
+
+    def get(url, params = {})
+      response = @connection.get do |req|
+        req.url url
+        req.headers['Api-Token'] = ActiveCampaignCrm.configuration.api_key
+        req.params = params
+      end
+      handle_response(response)
+    end
+
+    def post(url, body)
+      response = @connection.post do |req|
+        req.url url
+        req.headers['Api-Token'] = ActiveCampaignCrm.configuration.api_key
+        req.body = body
+      end
+      handle_response(response)
+    end
+
+    def put(url, body)
+      response = @connection.put do |req|
+        req.url url
+        req.headers['Api-Token'] = ActiveCampaignCrm.configuration.api_key
+        req.body = body
+      end
+      handle_response(response)
+    end
+
+    def delete(url)
+      response = @connection.delete do |req|
+        req.url url
+        req.headers['Api-Token'] = ActiveCampaignCrm.configuration.api_key
+      end
+      handle_response(response)
+    end
+
+    def handle_response(response)
+      return JSON.parse response.body if response.success?
+
+      errors = JSON.parse(response.body)['errors']
+      error_messages = errors.map { |error| error['title'] } unless errors.nil?
+      error_message = error_messages.join('-') unless error_messages.nil?
+
+      case response.status
+      when 400
+        raise ActiveCampaignCrm::BadRequest, error_message
+      when 404
+        raise ActiveCampaignCrm::NotFound, error_message
+      when 429
+        raise ActiveCampaignCrm::TooManyRequests, error_message
+      when 500
+        raise ActiveCampaignCrm::InternalServerError, error_message
+      when 502
+        raise ActiveCampaignCrm::BadGateway, error_message
+      when 503
+        raise ActiveCampaignCrm::ServiceUnavailable, error_message
+      when 504
+        raise ActiveCampaignCrm::GatewayTimeout, error_message
+      else
+        raise StandardError, error_message
+      end
+    end
+  end
+end

data/lib/active_campaign_crm/error.rb

@@ -0,0 +1,25 @@
+module ActiveCampaignCrm
+  # Custom error class for rescuing from all errors
+  class Error < StandardError; end
+
+  # Raised when Active Campaign returns the HTTP status code 400
+  class BadRequest < Error; end
+
+  # Raised when Active Campaign returns the HTTP status code 404
+  class NotFound < Error; end
+
+  # Raised when Active Campaign returns the HTTP status code 429
+  class TooManyRequests < Error; end
+
+  # Raised when Active Campaign returns the HTTP status code 500
+  class InternalServerError < Error; end
+
+  # Raised when Active Campaign returns the HTTP status code 502
+  class BadGateway < Error; end
+
+  # Raised when Active Campaign returns the HTTP status code 503
+  class ServiceUnavailable < Error; end
+
+  # Raised when Active Campaign returns the HTTP status code 504
+  class GatewayTimeout < Error; end
+end

data/lib/active_campaign_crm/version.rb

@@ -0,0 +1,3 @@
+module ActiveCampaignCrm
+  VERSION = "0.1.0"
+end

data/lib/active_campaign_crm.rb

@@ -0,0 +1,10 @@
+require 'active_campaign_crm/version'
+require 'active_campaign_crm/client'
+require 'active_campaign_crm/configuration'
+
+module ActiveCampaignCrm
+
+  def self.client
+    ActiveCampaignCrm::Client.new(options)
+  end
+end

metadata

@@ -0,0 +1,123 @@
+--- !ruby/object:Gem::Specification
+name: active_campaign_crm
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Nuno Correia
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-04-04 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.15'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.15'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !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'
+description: 'A basic API wrapper for active campaign '
+email:
+- nuno_lopes@whitesmith.co
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- Rakefile
+- active_campaign_crm.gemspec
+- bin/console
+- bin/setup
+- lib/active_campaign_crm.rb
+- lib/active_campaign_crm/client.rb
+- lib/active_campaign_crm/client/contact_fields.rb
+- lib/active_campaign_crm/client/contacts.rb
+- lib/active_campaign_crm/client/custom_field_values.rb
+- lib/active_campaign_crm/client/organizations.rb
+- lib/active_campaign_crm/client/tags.rb
+- lib/active_campaign_crm/configuration.rb
+- lib/active_campaign_crm/connection.rb
+- lib/active_campaign_crm/error.rb
+- lib/active_campaign_crm/version.rb
+homepage: 
+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.7.3
+signing_key: 
+specification_version: 4
+summary: A basic API wrapper for active campaign
+test_files: []