ractive_campaign 0.1.1 → 0.1.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a1f97cdac78234978c3b5e8d87359883ba8844d646fd7ed2d0c41a50168537f4
-  data.tar.gz: 55f1c00eb4a214570eb4a9d97c43e62e0d396f725769b81a62f096d111902315
+  metadata.gz: f0f3b24a31bfe00c8c7bbe97b2a480cb6c7d5ea0838e01b7beb79311e3ee5d43
+  data.tar.gz: 9ca59df1246b16a23d7640ce60552328a9e0802f438e645348e91e728cf9db66
 SHA512:
-  metadata.gz: a86d70655730f310016ba26ea518d0e53f461479de71cd9dd72e214c07c72b86983ed499b641eb3cb866d28724bdd88513464442e5cdd4244d5f076ac1fa7c86
-  data.tar.gz: 5b76063e260e6df6d49854111b74f4192352d3ed2b0c3d81326644519510d64194def26f22da60bd8661966a78be0d83155288bc124d7a006d70e8dc8e0a6ead
+  metadata.gz: 95566c3ad4cf971380b2486058f315c16cb0f8ad5263e145167d40d96ee30d22c85079a5d4ee8868b1effc8a37f7d32d2e1d30fc215f4db555bb6544f309b589
+  data.tar.gz: 0ea82c9eb5b94efb4e881b10b603e8c035f226630f67115f173c28dcdae4b202e011710bedf11e73df880c9118c67778a56c7efdab97619de6b18eb09335bcde

data/CHANGELOG.md

@@ -1,5 +1,42 @@
 ## [Unreleased]
 
-## [0.1.0] - 2021-11-10
+## [0.1.5] - 2021-11-19
+### Changed
+
+- when adding a tag to a contact, create it if it doesn't exist
+
+## [0.1.4] - 2021-11-19
+### Changed
+
+- loading endpoint result into the correct model class
+- README section on `install and require`
+
+## [0.1.3] - 2021-11-18
+### Added
+
+- account contact
+- campaign
+- contact automatin
+- etc
+
+### Changed
+
+- attrs config
+- README config info
+
+## [0.1.2] - 2021-11-17
+### Added
+
+- list
+- etc
+
+## [0.1.0] - 2021-11-13
+### Added
+
+- contact
+- tags
+- etc
+
+## [0.0.1] - 2021-11-10
 
 - Initial release

data/Gemfile.lock

@@ -1,9 +1,9 @@
 PATH
   remote: .
   specs:
-    ractive_campaign (0.1.1)
+    ractive_campaign (0.1.5)
       activemodel (~> 6.1.4)
-      dry-configurable (~> 0.7.0)
+      dry-configurable (~> 0.12.1)
       faraday (~> 1.8.0)
       faraday_middleware (~> 1.2.0)
 
@@ -28,7 +28,10 @@ GEM
       rexml
     diff-lcs (1.4.4)
     dotenv (2.7.6)
-    dry-configurable (0.7.0)
+    dry-configurable (0.12.1)
+      concurrent-ruby (~> 1.0)
+      dry-core (~> 0.5, >= 0.5.0)
+    dry-core (0.7.1)
       concurrent-ruby (~> 1.0)
     faraday (1.8.0)
       faraday-em_http (~> 1.0)
@@ -88,7 +91,7 @@ GEM
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.10.0)
     rspec-support (3.10.3)
-    rubocop (1.22.3)
+    rubocop (1.23.0)
       parallel (~> 1.10)
       parser (>= 3.0.0.0)
       rainbow (>= 2.2.2, < 4.0)

data/README.md

@@ -1,13 +1,15 @@
+[![Gem Version](https://badge.fury.io/rb/ractive_campaign.svg)](https://badge.fury.io/rb/ractive_campaign) [![Maintainability](https://api.codeclimate.com/v1/badges/c23221fc334b63af9a07/maintainability)](https://codeclimate.com/github/wedsonlima/ractive_campaign/maintainability) [![Test Coverage](https://api.codeclimate.com/v1/badges/c23221fc334b63af9a07/test_coverage)](https://codeclimate.com/github/wedsonlima/ractive_campaign/test_coverage)
+
 # RactiveCampaign
 
-Simple wrapper for ActiveCampaign API v3
+Ruby API wrapper for ActiveCampaign API v3
 
 ## Installation
 
 Add this line to your application's Gemfile:
 
 ```ruby
-gem 'ractive_campaign'
+gem "ractive_campaign"
 ```
 
 And then execute:
@@ -37,11 +39,15 @@ end
 
 ```ruby
 # new
-harry = ActiveCampaign::Contact.new firstName: "Harry", lastName: "Potter", email: "potter.hurray@hogwash.com"
+harry = ActiveCampaign::Contact.new firstName: "Harry",
+                                    lastName: "Potter",
+                                    email: "potter.hurray@hogwash.com"
 harry.save
 
 # create
-hermione = ActiveCampaign::Contact.new firstName: "Hermione", lastName: "Granger", email: "mione@drtooth.com"
+hermione = ActiveCampaign::Contact.new firstName: "Hermione",
+                                       lastName: "Granger",
+                                       email: "mione@drtooth.com"
 
 # update
 ron = ActiveCampaign::Contact.create email: "ron1988@hogwash.com", lastName: "Weasley"
@@ -52,7 +58,7 @@ ron.save
 #### Tag
 
 ```ruby
-ActiveCampaign::Contact.create tag: "hogwarts"
+ActiveCampaign::Tag.create tag: "hogwarts"
 ```
 
 #### Contact tags
@@ -69,7 +75,7 @@ harry.remove_tag "hogwarts"
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/ractive_campaign. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/[USERNAME]/ractive_campaign/blob/master/CODE_OF_CONDUCT.md).
+Bug reports and pull requests are welcome on GitHub at https://github.com/wedsonlima/ractive_campaign. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/[USERNAME]/ractive_campaign/blob/master/CODE_OF_CONDUCT.md).
 
 ## License
 

data/lib/active_campaign/api_http.rb

@@ -10,16 +10,16 @@ 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 = if root
-                parsed_data[:data][root.to_sym]
+              data = if parsed_data[:data].keys.include?(root_element.to_sym)
+                parsed_data[:data][root_element.to_sym]
+              elsif parsed_data[:data].keys.include?(root_elements.to_sym)
+                parsed_data[:data][root_elements.to_sym]
               else
-                parsed_data[:data].first.last
+                parsed_data[:data]
               end
 
               if data.is_a?(Array)

data/lib/active_campaign/models/account_contact.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module ActiveCampaign
+  class AccountContact < Model # :nodoc:
+    define_attributes :contact,
+                      :account,
+                      :jobTitle
+  end
+end

data/lib/active_campaign/models/campaign.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module ActiveCampaign
+  class Campaign < Model # :nodoc:
+    # REVIEW: only list
+  end
+end

data/lib/active_campaign/models/contact.rb

@@ -24,14 +24,22 @@ module ActiveCampaign
       ContactTag.get "#{self.class.endpoint}/#{id}/contactTags"
     end
 
-    # @example Apply a tag to a contact.
+    # @example Add a tag to a contact.
     #
     #   ActiveCampaign::Contact.find(1).add_tag "tag-name"
     #
-    def add_tag(tag)
+    # Don't create the tag if it doesn't exist.
+    #
+    #   ActiveCampaign::Contact.find(1).add_tag "tag-name", create_if_not_found: false
+    #
+    def add_tag(tag, create_if_not_found: true)
       tag_id = Tag.find_by(tag: tag)&.id
 
-      ActiveCampaign::ContactTag.create contact: id, tag: tag_id if tag_id
+      tag_id = ActiveCampaign::Tag.create(tag: tag)&.id if !tag_id && create_if_not_found
+
+      return false unless tag_id
+
+      ActiveCampaign::ContactTag.create contact: id, tag: tag_id
     end
 
     # @example Remove a tag from a contact.
@@ -41,6 +49,8 @@ module ActiveCampaign
     def remove_tag(tag)
       tag_id = Tag.find_by(tag: tag)&.id
 
+      return false unless tag_id
+
       contact_tag = contact_tags.filter_map { |ct| ct if ct.tag == tag_id }.last
 
       contact_tag&.destroy

data/lib/active_campaign/models/contact_automation.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module ActiveCampaign
+  class ContactAutomation < Model # :nodoc:
+    define_attributes :contact, :automation
+  end
+end

data/lib/active_campaign/models/contact_deal.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module ActiveCampaign
+  class ContactDeal < Model # :nodoc:
+    define_attributes :contact, :deal
+  end
+end

data/lib/active_campaign/models/contact_tag.rb

@@ -4,8 +4,8 @@ module ActiveCampaign
   #
   # @example ContactTags
   #
-  #   contact = ActiveCampaign::Contact.find(email: "contact-email@mail.com")
-  #   tag = ActiveCampaign::Tag.find_by(tag: "tag-name")
+  #   contact = ActiveCampaign::Contact.find(1)
+  #   tag = ActiveCampaign::Tag.find(1)
   #
   #   ActiveCampaing::ContactTag.create contact: contact, tag: tag
   #

data/lib/active_campaign/models/custom_deal_field.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module ActiveCampaign
+  class CustomDealField < Model # :nodoc:
+    define_attributes :fieldLabel,
+                      :fieldType,
+                      :fieldDefault,
+                      :isFormVisible,
+                      :displayOrder
+
+    class << self
+      def endpoint
+        "dealCustomFieldMeta"
+      end
+
+      def root_element
+        :dealCustomFieldMetum
+      end
+    end
+  end
+end

data/lib/active_campaign/models/custom_deal_field_value.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module ActiveCampaign
+  class CustomDealFieldValue < Model # :nodoc:
+    define_attributes :dealId,
+                      :customFieldId,
+                      :fieldValue,
+                      :fieldCurrency
+
+    class << self
+      def endpoint
+        "dealCustomFieldData"
+      end
+
+      def root_element
+        :dealCustomFieldDatum
+      end
+    end
+  end
+end

data/lib/active_campaign/models/deal.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module ActiveCampaign
+  class Deal < Model # :nodoc:
+    define_attributes :contact,
+                      :account,
+                      :description,
+                      :currency,
+                      :group,
+                      :owner,
+                      :percent,
+                      :stage,
+                      :status,
+                      :title,
+                      :value
+  end
+end

data/lib/active_campaign/models/email_activity.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module ActiveCampaign
+  class EmailActivity < Model # :nodoc:
+    # REVIEW: only listing
+  end
+end

data/lib/active_campaign/models/field.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module ActiveCampaign
+  class Field < Model # :nodoc:
+    define_attributes :type,
+                      :title,
+                      :descript,
+                      :perstag,
+                      :defval,
+                      :visible,
+                      :ordernum
+  end
+end

data/lib/active_campaign/models/field_value.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module ActiveCampaign
+  class FieldValue < Model # :nodoc:
+    define_attributes :contact,
+                      :field,
+                      :value
+  end
+end

data/lib/active_campaign/models/list.rb

@@ -2,46 +2,10 @@
 
 module ActiveCampaign
   class List < Model # :nodoc:
-    define_attributes :stringid,
-                      :userid,
-                      :name,
-                      :p_use_tracking,
-                      :p_use_analytics_read,
-                      :p_use_analytics_link,
-                      :p_use_twitter,
-                      :p_use_facebook,
-                      :p_embed_image,
-                      :p_use_captcha,
-                      :send_last_broadcast,
-                      :private,
-                      :analytics_domains,
-                      :analytics_source,
-                      :analytics_ua,
-                      :twitter_token,
-                      :twitter_token_secret,
-                      :facebook_session,
-                      :carboncopy,
-                      :subscription_notify,
-                      :unsubscription_notify,
-                      :require_name,
-                      :get_unsubscribe_reason,
-                      :to_name,
-                      :optinoptout,
-                      :sender_name,
-                      :sender_addr1,
-                      :sender_addr2,
-                      :sender_city,
-                      :sender_state,
-                      :sender_zip,
-                      :sender_country,
-                      :sender_phone,
+    define_attributes :name,
+                      :stringid,
                       :sender_url,
                       :sender_reminder,
-                      :fulladdress,
-                      :optinmessageid,
-                      :optoutconf,
-                      :deletestamp,
-                      :udate,
                       :user
   end
 end

data/lib/active_campaign/models/model.rb

@@ -24,7 +24,7 @@ module ActiveCampaign
       end
 
       def find(id)
-        get "#{endpoint}/#{id}", { _root: root_element }
+        get "#{endpoint}/#{id}"
       end
 
       def save(**args)

data/lib/active_campaign/models/pipeline.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module ActiveCampaign
+  class Pipeline < Model # :nodoc:
+    define_attributes :allgroups,
+                      :allusers,
+                      :autoassign,
+                      :currency,
+                      :title,
+                      :users
+
+    class << self
+      def endpoint
+        "dealGroups"
+      end
+    end
+  end
+end

data/lib/active_campaign/models/stage.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module ActiveCampaign
+  class Stage < Model # :nodoc:
+    define_attributes :cardRegion1,
+                      :cardRegion2,
+                      :cardRegion3,
+                      :cardRegion4,
+                      :cardRegion5,
+                      :color,
+                      :dealOrder,
+                      :group,
+                      :order,
+                      :title,
+                      :width
+    class << self
+      def endpoint
+        "dealStages"
+      end
+    end
+  end
+end

data/lib/active_campaign/models/tag.rb

@@ -3,5 +3,11 @@
 module ActiveCampaign
   class Tag < Model # :nodoc:
     define_attributes :tag, :tagType, :description
+
+    def create
+      self.tagType ||= "contact"
+
+      super
+    end
   end
 end

data/lib/active_campaign/models/task.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module ActiveCampaign
+  class Task < Model # :nodoc:
+    define_attributes :title,
+                      :ownerType,
+                      :relid,
+                      :status,
+                      :note,
+                      :duedate,
+                      :edate,
+                      :dealTasktype,
+                      :assignee,
+                      :triggerAutomationOnCreate,
+                      :doneAutomation
+
+    class << self
+      def endpoint
+        "dealTasks"
+      end
+    end
+  end
+end

data/lib/active_campaign/models/task_outcome.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module ActiveCampaign
+  class TaskOutcome < Model # :nodoc:
+    define_attributes :title, :sentiment
+  end
+end

data/lib/active_campaign/models/task_type.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module ActiveCampaign
+  class TaskType < Model # :nodoc:
+    define_attributes :title, :status
+
+    class << self
+      def endpoint
+        "dealTasktypes"
+      end
+    end
+  end
+end

data/lib/active_campaign/models/user.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module ActiveCampaign
+  class User < Model # :nodoc:
+    class << self
+      def find_by_email(email)
+        get "#{endpoint}/email/#{email}"
+      end
+
+      def find_by_username(username)
+        get "#{endpoint}/username/#{username}"
+      end
+    end
+  end
+end

data/lib/active_campaign/version.rb

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

data/lib/ractive_campaign.rb

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+
+require "active_campaign"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ractive_campaign
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.5
 platform: ruby
 authors:
 - Wedson Lima
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-11-16 00:00:00.000000000 Z
+date: 2021-11-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activemodel
@@ -30,14 +30,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.7.0
+        version: 0.12.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.7.0
+        version: 0.12.1
 - !ruby/object:Gem::Dependency
   name: faraday
   requirement: !ruby/object:Gem::Requirement
@@ -66,7 +66,7 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 1.2.0
-description: Active Campaign - API v3
+description: Ruby API wrapper for ActiveCampaign API v3
 email:
 - wedson.sousa.lima@gmail.com
 executables: []
@@ -89,19 +89,40 @@ files:
 - lib/active_campaign/api_attributes.rb
 - lib/active_campaign/api_http.rb
 - lib/active_campaign/models/account.rb
+- lib/active_campaign/models/account_contact.rb
 - lib/active_campaign/models/address.rb
+- lib/active_campaign/models/campaign.rb
 - lib/active_campaign/models/contact.rb
+- lib/active_campaign/models/contact_automation.rb
+- lib/active_campaign/models/contact_deal.rb
 - lib/active_campaign/models/contact_tag.rb
+- lib/active_campaign/models/custom_deal_field.rb
+- lib/active_campaign/models/custom_deal_field_value.rb
+- lib/active_campaign/models/deal.rb
+- lib/active_campaign/models/email_activity.rb
+- lib/active_campaign/models/field.rb
+- lib/active_campaign/models/field_value.rb
 - lib/active_campaign/models/list.rb
 - lib/active_campaign/models/model.rb
 - lib/active_campaign/models/note.rb
+- lib/active_campaign/models/pipeline.rb
+- lib/active_campaign/models/stage.rb
 - lib/active_campaign/models/tag.rb
+- lib/active_campaign/models/task.rb
+- lib/active_campaign/models/task_outcome.rb
+- lib/active_campaign/models/task_type.rb
+- lib/active_campaign/models/user.rb
 - lib/active_campaign/parser.rb
 - lib/active_campaign/version.rb
+- lib/ractive_campaign.rb
 homepage: https://github.com/wedsonlima/ractive_campaign
 licenses:
 - MIT
-metadata: {}
+metadata:
+  homepage_uri: https://github.com/wedsonlima/ractive_campaign
+  source_code_uri: https://github.com/wedsonlima/ractive_campaign
+  changelog_uri: https://github.com/wedsonlima/ractive_campaign/blob/main/CHANGELOG.md
+  documentation_uri: https://www.rubydoc.info/gems/ractive_campaign/0.1.5
 post_install_message: 
 rdoc_options: []
 require_paths:
@@ -120,5 +141,5 @@ requirements: []
 rubygems_version: 3.0.3.1
 signing_key: 
 specification_version: 4
-summary: Active Campaign - API v3
+summary: Ruby API wrapper for ActiveCampaign API v3
 test_files: []