ractive_campaign 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bea9a04deb5b0cdfadc355f3e4ee086355a97bab723e4cdff4c1b6b7caf5b2ee
-  data.tar.gz: d7725b4597f94558074d7b56c2592f9ad30b18c6afb5f0df90dd2cc215b0abed
+  metadata.gz: a1f97cdac78234978c3b5e8d87359883ba8844d646fd7ed2d0c41a50168537f4
+  data.tar.gz: 55f1c00eb4a214570eb4a9d97c43e62e0d396f725769b81a62f096d111902315
 SHA512:
-  metadata.gz: 17b27596b7f367df37952a6b4256d906d1e5cc5bd1697088b94dccd4c9cfe93f52f637af47db98db9d85111f8ef571877b0ea7c0e5d93c61a554f82df35c3a3d
-  data.tar.gz: 9770a5164db9c6d2923025db4a5e3c5a1a87d1e83db4a9c74fd175630e1144ee8f4bedd3db6c5281a4eeb0167d3ccffbc9cd1f1b084ad39ebfc16ebc6e0fff25
+  metadata.gz: a86d70655730f310016ba26ea518d0e53f461479de71cd9dd72e214c07c72b86983ed499b641eb3cb866d28724bdd88513464442e5cdd4244d5f076ac1fa7c86
+  data.tar.gz: 5b76063e260e6df6d49854111b74f4192352d3ed2b0c3d81326644519510d64194def26f22da60bd8661966a78be0d83155288bc124d7a006d70e8dc8e0a6ead

data/Gemfile.lock

@@ -1,13 +1,11 @@
 PATH
   remote: .
   specs:
-    ractive_campaign (0.1.0)
+    ractive_campaign (0.1.1)
       activemodel (~> 6.1.4)
-      activesupport (~> 6.1.4)
       dry-configurable (~> 0.7.0)
       faraday (~> 1.8.0)
       faraday_middleware (~> 1.2.0)
-      oj (>= 3.0, < 4.0)
 
 GEM
   remote: https://rubygems.org/
@@ -62,7 +60,6 @@ GEM
     method_source (1.0.0)
     minitest (5.14.4)
     multipart-post (2.1.1)
-    oj (3.13.9)
     parallel (1.21.0)
     parser (3.0.2.0)
       ast (~> 2.4.1)

data/README.md

@@ -1,8 +1,6 @@
 # RactiveCampaign
 
-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/ractive_campaign`. To experiment with that code, run `bin/console` for an interactive prompt.
-
-TODO: Delete this and the text above, and describe your gem
+Simple wrapper for ActiveCampaign API v3
 
 ## Installation
 
@@ -22,13 +20,52 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+### Config
+
+```ruby
+# config/initializers/ractive_campaign.rb
+
+ActiveCampaign.configure do |config|
+  config.api_url = ENV["AC_API_URL"] # ex.: https://mystartup.api-us1.com/api/3
+  config.api_key = ENV["AC_API_KEY"]
+end
+```
+
+### Examples
+
+#### Contact
 
-## Development
+```ruby
+# new
+harry = ActiveCampaign::Contact.new firstName: "Harry", lastName: "Potter", email: "potter.hurray@hogwash.com"
+harry.save
 
-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.
+# create
+hermione = ActiveCampaign::Contact.new firstName: "Hermione", lastName: "Granger", email: "mione@drtooth.com"
+
+# update
+ron = ActiveCampaign::Contact.create email: "ron1988@hogwash.com", lastName: "Weasley"
+ron.firstName = "Ron"
+ron.save
+```
 
-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 the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+#### Tag
+
+```ruby
+ActiveCampaign::Contact.create tag: "hogwarts"
+```
+
+#### Contact tags
+
+```ruby
+harry = ActiveCampaign::Contact.find_by email: "potter.hurray@hogwash.com"
+
+# add a contact tag
+harry.add_tag "hogwargs"
+
+# remove a tag
+harry.remove_tag "hogwarts"
+```
 
 ## Contributing
 

data/lib/active_campaign/api_attributes.rb

@@ -4,20 +4,6 @@ module ActiveCampaign
   module Attributes # :nodoc:
     extend ActiveSupport::Concern
 
-    attr_accessor :all_attrs
-
-    DEFAULT_ATTRS = %i[
-      id
-      cdate
-      created_timestamp
-      updated_timestamp
-      created_utc_timestamp
-      updated_utc_timestamp
-      created_by
-      updated_by
-      links
-    ].freeze
-
     def only_changes_to_params
       return nil unless changed?
 
@@ -29,7 +15,7 @@ module ActiveCampaign
     end
 
     def to_params
-      iv = instance_variables - DEFAULT_ATTRS.map { |da| :"@#{da}" } - %i[@mutations_from_database @mutations_before_last_save]
+      iv = instance_variables - %i[@mutations_from_database @mutations_before_last_save]
 
       {
         self.class.root_element => iv.map { |v| [v.to_s.delete("@"), instance_variable_get(v)] }.to_h
@@ -39,6 +25,7 @@ module ActiveCampaign
     module ClassMethods # :nodoc:
       def define_attributes(*attrs)
         attrs.each do |attr|
+          # ActiveModel's define_attribute_methods
           define_attribute_methods attr
 
           class_eval <<-RUBY, __FILE__, __LINE__ + 1
@@ -63,6 +50,8 @@ module ActiveCampaign
       end
 
       def instantiate_record(klass, data)
+        define_attributes(*data.keys)
+
         record = klass.new data
         record.clear_changes_information
         record
@@ -75,11 +64,11 @@ module ActiveCampaign
       end
 
       def endpoint
-        name.demodulize.underscore.pluralize
+        name.demodulize.camelize(:lower).pluralize
       end
 
       def root_element
-        name.demodulize.underscore.to_sym
+        name.demodulize.camelize(:lower).to_sym
       end
 
       def root_elements

data/lib/active_campaign/api_http.rb

@@ -10,11 +10,17 @@ module ActiveCampaign
       HTTP_METHODS.each do |method|
         class_eval <<-RUBY, __FILE__, __LINE__ + 1
           def #{method}(path, params={})
+            root = params.delete(:_root)
+
             send(:'#{method}_raw', path, params) do |parsed_data, response|
               return {} unless [200, 201].include?(parsed_data[:status_code])
               return {} unless parsed_data[:data].present?
 
-              data = parsed_data[:data].first.last
+              data = if root
+                parsed_data[:data][root.to_sym]
+              else
+                parsed_data[:data].first.last
+              end
 
               if data.is_a?(Array)
                 new_records data

data/lib/active_campaign/models/account.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module ActiveCampaign
+  class Account < Model # :nodoc:
+    define_attributes :name, :accountUrl
+  end
+end

data/lib/active_campaign/models/address.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module ActiveCampaign
+  class Address < Model # :nodoc:
+    define_attributes :company_name, :address_1, :country
+  end
+end

data/lib/active_campaign/models/contact.rb

@@ -1,36 +1,49 @@
 # frozen_string_literal: true
 
 module ActiveCampaign
-  class Contact < Model # :nodoc:
+  #
+  # @example Contacts
+  #
+  #   ActiveCampaign::Contact.find(1)
+  #   ActiveCampaign::Contact.find_by email: "contact-1@mail.com"
+  #   ActiveCampaign::Contact.find(1).destroy
+  #   ActiveCampaign::Contact.find(1).contact_tags
+  #
+  class Contact < Model
     define_attributes :email,
                       :phone,
                       :firstName,
-                      :lastName,
-                      :orgid,
-                      :orgname,
-                      :segmentio_id,
-                      :bounced_hard,
-                      :bounced_soft,
-                      :bounced_date,
-                      :ip,
-                      :ua,
-                      :hash,
-                      :socialdata_lastcheck,
-                      :email_local,
-                      :email_domain,
-                      :sentcnt,
-                      :rating_tstamp,
-                      :gravatar,
-                      :deleted,
-                      :anonymized,
-                      :adate,
-                      :udate,
-                      :edate,
-                      :deleted_at,
-                      :email_empty,
-                      :mpp_tracking,
-                      :scoreValues,
-                      :accountContacts,
-                      :organization
+                      :lastName
+
+    # @example Find contact's tags.
+    #
+    #   ActiveCampaign::Contact.find(1).contact_tags
+    #   ActiveCampaign::Contact.find(1).contact_tags.last.destroy
+    #
+    def contact_tags
+      ContactTag.get "#{self.class.endpoint}/#{id}/contactTags"
+    end
+
+    # @example Apply a tag to a contact.
+    #
+    #   ActiveCampaign::Contact.find(1).add_tag "tag-name"
+    #
+    def add_tag(tag)
+      tag_id = Tag.find_by(tag: tag)&.id
+
+      ActiveCampaign::ContactTag.create contact: id, tag: tag_id if tag_id
+    end
+
+    # @example Remove a tag from a contact.
+    #
+    #   ActiveCampaign::Contact.find(1).remove_tag "tag-name"
+    #
+    def remove_tag(tag)
+      tag_id = Tag.find_by(tag: tag)&.id
+
+      contact_tag = contact_tags.filter_map { |ct| ct if ct.tag == tag_id }.last
+
+      contact_tag&.destroy
+    end
   end
 end

data/lib/active_campaign/models/contact_tag.rb

@@ -1,7 +1,40 @@
 # frozen_string_literal: true
 
 module ActiveCampaign
-  class ContactTag < Model # :nodoc:
-    define_attributes :tag_id, :contact_id
+  #
+  # @example ContactTags
+  #
+  #   contact = ActiveCampaign::Contact.find(email: "contact-email@mail.com")
+  #   tag = ActiveCampaign::Tag.find_by(tag: "tag-name")
+  #
+  #   ActiveCampaing::ContactTag.create contact: contact, tag: tag
+  #
+  class ContactTag < Model
+    define_attributes :contact, :tag
+
+    def create
+      self.tag = extract_id_from_tag(tag)
+      self.contact = extract_id_from_contact(contact)
+
+      super
+    end
+
+    private
+
+    def extract_id_from_tag(tag)
+      case tag
+      when ::ActiveCampaign::Tag then tag.id
+      else
+        tag
+      end
+    end
+
+    def extract_id_from_contact(contact)
+      case contact
+      when ::ActiveCampaign::Contact then contact.id
+      else
+        contact
+      end
+    end
   end
 end

data/lib/active_campaign/models/model.rb

@@ -8,23 +8,23 @@ module ActiveCampaign
     include ActiveCampaign::ApiHttp
     include ActiveCampaign::Attributes
 
-    define_attributes(*DEFAULT_ATTRS)
-
     class << self
       def all
         get endpoint
       end
 
       def filter(args = {})
-        get "#{endpoint}?#{args}"
+        query = args.map { |k, v| "filters[#{k}]=#{v}" }.join "&"
+
+        get "#{endpoint}?#{query}"
       end
 
       def find_by(args = {})
-        filter(args.to_query).last
+        filter(args).last
       end
 
       def find(id)
-        get "#{endpoint}/#{id}"
+        get "#{endpoint}/#{id}", { _root: root_element }
       end
 
       def save(**args)
@@ -37,7 +37,7 @@ module ActiveCampaign
     end
 
     def save
-      return update if id.present?
+      return update if defined?(id) && id.present?
 
       create
     end
@@ -47,17 +47,21 @@ module ActiveCampaign
 
       result = self.class.put "#{self.class.endpoint}/#{id}", only_changes_to_params
 
+      assign_attributes result.to_params.first.last
+
       changes_applied
 
-      result
+      self
     end
 
     def create
       result = self.class.post self.class.endpoint, to_params
 
+      assign_attributes result.to_params.first.last
+
       changes_applied
 
-      result
+      self
     end
 
     def destroy

data/lib/active_campaign/models/note.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module ActiveCampaign
+  class Note < Model # :nodoc:
+    define_attributes :note, :relid, :reltype
+  end
+end

data/lib/active_campaign/models/tag.rb

@@ -2,12 +2,6 @@
 
 module ActiveCampaign
   class Tag < Model # :nodoc:
-    define_attributes :tagType, :tag, :description, :subscriber_count
-
-    class << self
-      def find_by(tag:)
-        filter({ tags: { tag: tag } }.to_query).last
-      end
-    end
+    define_attributes :tag, :tagType, :description
   end
 end

data/lib/active_campaign/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module ActiveCampaign
-  VERSION = "0.1.0"
+  VERSION = "0.1.1"
 end

data/lib/active_campaign.rb

@@ -12,7 +12,6 @@ require "active_support/inflector"
 require "active_campaign/version"
 require "active_campaign/parser"
 require "active_campaign/api_attributes"
-require "active_campaign/api_errors"
 require "active_campaign/api"
 require "active_campaign/api_http"
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ractive_campaign
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Wedson Lima
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-11-13 00:00:00.000000000 Z
+date: 2021-11-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activemodel
@@ -24,20 +24,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 6.1.4
-- !ruby/object:Gem::Dependency
-  name: activesupport
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 6.1.4
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 6.1.4
 - !ruby/object:Gem::Dependency
   name: dry-configurable
   requirement: !ruby/object:Gem::Requirement
@@ -80,26 +66,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 1.2.0
-- !ruby/object:Gem::Dependency
-  name: oj
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '3.0'
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '4.0'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '3.0'
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '4.0'
 description: Active Campaign - API v3
 email:
 - wedson.sousa.lima@gmail.com
@@ -121,12 +87,14 @@ files:
 - lib/active_campaign.rb
 - lib/active_campaign/api.rb
 - lib/active_campaign/api_attributes.rb
-- lib/active_campaign/api_errors.rb
 - lib/active_campaign/api_http.rb
+- lib/active_campaign/models/account.rb
+- lib/active_campaign/models/address.rb
 - lib/active_campaign/models/contact.rb
 - lib/active_campaign/models/contact_tag.rb
 - lib/active_campaign/models/list.rb
 - lib/active_campaign/models/model.rb
+- lib/active_campaign/models/note.rb
 - lib/active_campaign/models/tag.rb
 - lib/active_campaign/parser.rb
 - lib/active_campaign/version.rb

data/lib/active_campaign/api_errors.rb

@@ -1,47 +0,0 @@
-# frozen_string_literal: true
-
-module ActiveCampaign
-  class Error < RuntimeError # :nodoc:
-    def initialize(response = nil, exception = nil)
-      super
-
-      self.response = response
-      @exception = exception
-    end
-
-    def message
-      if response.nil?
-        super
-      else
-        <<~MESSAGE
-          STATUS: #{response.status}
-          URL: #{env.url}
-          REQUEST HEADERS: #{env.request_headers}
-          RESPONSE_HEADERS: #{env.response_headers}
-          REQUEST_BODY: #{env.request_body}\n\n"
-          RESPONSE_BODY: #{response.body}\n\n"
-        MESSAGE
-      end
-    end
-
-    private
-
-    def env
-      @env ||= response.env
-    end
-
-    attr_accessor :response
-  end
-
-  class ClientError < Error
-  end
-
-  class UnauthorizedError < ClientError
-  end
-
-  class ResourceNotFound < ClientError
-  end
-
-  class UnprocessableEntityError < ClientError
-  end
-end