mautic_api 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 6c0377d4275602d93edfae7d0ac8109d516d7e6baabd86e6101d97b9b3924eba
+  data.tar.gz: 2718533221f8c003cd4dee335a5abc02345da7748a17f43c83b72c00c3c33521
+SHA512:
+  metadata.gz: 990ec179a899e644717cede7fad70babd70af5adc63a4d5a9ff18cf0dca8aad3697943f6e7ab175005315cb89ea33ba91c63b137480cb96b846de16f7b6de9bd
+  data.tar.gz: e5b1324f9521bf3480dce847b5ace649628da43affd445083cc4ad2c65feeab938c275434063a057c4a96a09468c7a049064529ff2b8c64509150b7dadcd0e64

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2016 YOURNAME
+
+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/Rakefile

@@ -0,0 +1,32 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rdoc/task'
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'MauticApi'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+
+
+
+Bundler::GemHelper.install_tasks
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+
+task default: :test

data/lib/mautic_api.rb

@@ -0,0 +1,41 @@
+# @package     Mautic
+# @copyright   2016 trampos.co. All rights reserved.
+# @author      marcel@trampos.co
+# @link        http://trampos.co
+# @license     MIT http://opensource.org/licenses/MIT
+
+require "mautic_api/engine"
+
+module MauticApi
+    
+    autoload :Auth,                           'mautic_api/auth/auth'
+    autoload :Api,                            'mautic_api/api/api'
+    autoload :Contacts,                       'mautic_api/api/contacts'
+    autoload :Companies,                      'mautic_api/api/companies'
+    autoload :Segments,                       'mautic_api/api/segments'
+    autoload :ContextNotFoundException,       'mautic_api/exception/context_not_found_exception'
+
+
+    class Context
+        
+        # Get an API context object
+        #
+        # @param string        $apiContext API context (leads, forms, etc)
+        # @param AuthInterface $auth       API Auth object
+        # @param string        $baseUrl    Base URL for API endpoints
+        #
+        # @return Api\Api
+        # @throws ContextNotFoundException
+
+        def new_api api_context, auth, base_url=""
+            
+            class_name = "MauticApi::#{api_context.camelize}"
+
+            if Object.const_defined?(class_name)
+                return class_name.constantize.new(auth, base_url)
+            else
+                raise ContextNotFoundException "A context of 'api_context' was not found."
+            end
+        end
+    end
+end

data/lib/mautic_api/api/api.rb

@@ -0,0 +1,248 @@
+module MauticApi
+
+    class Api
+
+        attr_accessor :base_url, :auth
+
+        ENDPOINT = ""
+        LIST_NAME = ""
+        ITEM_NAME = ""
+        
+        BASE_API_ENDPOINT = 'api'
+    
+        def endpoint
+          self.class::ENDPOINT
+        end
+        
+        def list_name 
+            self.class::LIST_NAME
+        end
+
+        def item_name 
+            self.class::ITEM_NAME
+        end
+        
+        def base_api_endpoint
+          self.class::BASE_API_ENDPOINT
+        end
+        
+        def initialize auth, base_url
+            @auth = auth
+            set_base_url(base_url)
+        end
+
+        def set_base_url url
+            url += "/" if url[-1] != "/"
+            url += "api/" if url[-4,4] != "api/"
+            @base_url = url
+            return self 
+        end
+
+        def action_not_supported action
+            return {
+                error: {
+                    code: 500,
+                    message: "#{action} is not supported at this time."
+                }
+            }
+        end
+        
+        # Make the API request
+        #
+        # @param        $endpoint
+        # @param array  parameters
+        # @param string method
+        #
+        # @return array
+        # @throws \Exception
+
+        def make_request endpoint, parameters = {}, method = :get, settings = {}
+            
+            response = {}
+
+            # Validate if this endpoint has a BC url
+            bc_endpoint = nil
+
+            if @bc_attempt
+                if @bc_regex_endpoints.present?
+                    @bc_regex_endpoints.each do |regex, bc|
+
+                        if endpoint.scan(/@#{regex}@/)
+                            @bc_attempt = true
+                            bcEndpoint = endpoint.gsub(/@#{regex}@/, bc)
+                            break
+                        end
+                    end
+                end
+            end
+
+            url = "#{@base_url}#{endpoint}"
+            # Don't make the call if we're unit testing a BC endpoint
+
+            if !bc_endpoint || !@bc_testing || (bc_endpoint && @bc_testing && @bc_attempt)
+
+                # Hack for unit testing to ensure this isn't being called due to a bad regex
+                # if @bc_testing && !@bc_attempt
+
+                    # bt = debug_backtrace(DEBUG_BACKTRACE_IGNORE_ARGS, 2)
+                    # if !@bc_testing.kind_of?(Array)
+                    #     @bc_testing = [@bc_testing]
+                    # end
+
+                    # The method is not catching the BC endpoint so fail the test
+                    # if @bc_testing.include?($bt[1]['function'])
+                    #     throw new \Exception($endpoint.' not matched in '.var_export(@bc_regex_endpoints, true))
+                    # }
+                # end
+
+                @bc_attempt = false
+
+                if url.index('http').nil?
+                    error = {
+                        code: 500,
+                        message: "URL is incomplete.  Please use #{}, set the base URL as the third argument to MauticApi.newApi, or make endpoint a complete URL."
+                    }
+                else
+
+                    begin
+                        settings = {}
+
+                        if self.respond_to?(:get_temporary_file_path)
+                            settings[:temporary_file_path] = self.get_temporary_file_path
+                        end
+
+                        response = @auth.make_request(url, parameters, method, settings)
+                        
+                        # TODO: $this->getLogger()->debug('API Response', array('response' => $response))
+                        
+                        if response[:code] >= 300
+                            
+                            # TODO: $this->getLogger()->warning($response)
+                            # assume an error
+                            
+                            error = {
+                                code: response[:code],
+                                message: response[:body],
+                                response: response
+                            }
+                        end
+
+                    rescue Exception => e
+                        # TODO: $this->getLogger()->error('Failed connecting to Mautic API: '.$e->getMessage(), array('trace' => $e->getTraceAsString()))
+
+                        error = {
+                            code: 500,
+                            message: e
+                        }
+                    end
+                end
+
+                if error.present?
+                    return { errors: [error] }
+                end
+                
+                # Ensure a code is present in the error array
+                # if response[:errors].present?
+                #     info = @auth.get_response_info
+                #     response[:errors].each do |key, error|
+                #         if response[:errors][key]['code']
+                #             response[:errors][key]['code'] = info['http_code']
+                #         end
+                #     end
+                # end
+            end
+
+            # Check for a 404 code and a BC URL then try again if applicable
+            # if bc_endpoint && (@bc_testing || (response['errors'][0]['code'].to_i === 404))
+            #     @bc_attempt = true
+            #     return self.make_request(bc_endpoint, parameters, method)
+            # end
+
+            return response
+        end
+
+        # Get a single item
+        #
+        # @param int $id
+        #
+        # @returnarray|mixed
+        
+        def get id
+            return make_request("#{self.endpoint}/#{id}")
+        end
+
+        # Get a list of items
+        #
+        # @param string $search
+        # @param int    $start
+        # @param int    $limit
+        # @param string $orderBy
+        # @param string $orderByDir
+        # @param bool   $publishedOnly
+        #
+        # @return array|mixed
+        
+        def get_list search = '', start = 0, limit = 0, order_by = '', order_by_dir = 'ASC', published_only = false
+            
+            parameters = {}
+            
+            args = ['search', 'start', 'limit', 'order_by', 'order_by_dir', 'published_only']
+
+            args.each do |arg|
+                parameters[arg.to_sym] = (eval arg) if (eval arg).present?
+            end
+
+            return make_request(self.endpoint, parameters)
+        end
+
+        
+        # Proxy function to getList with $publishedOnly set to true
+        #
+        # @param string $search
+        # @param int    $start
+        # @param int    $limit
+        # @param string $orderBy
+        # @param string $orderByDir
+        #
+        # @return array|mixed
+        
+        def get_published_list search = '', start = 0, limit = 0, order_by = '', order_by_dir = 'ASC'
+            return get_list(search, start, limit, order_by, order_by_dir, true)
+        end
+
+        
+        # Create a new item (if supported)
+        #
+        # @param array parameters
+        #
+        # @return array|mixed
+        
+        def create parameters
+            return make_request("#{self.endpoint}/new", parameters, :post)
+        end
+        
+        # Edit an item with option to create if it doesn't exist
+        #
+        # @param int   $id
+        # @param array parameters
+        # @param bool  $createIfNotExists = false
+        #
+        # @return array|mixed
+    
+        def edit(id, parameters, create_if_not_exists = false)
+            method = create_if_not_exists ? :put : :patch
+            return make_request("#{self.endpoint}/#{id}/edit", parameters, method)
+        end
+
+        # Delete an item
+        #
+        # @param $id
+        #
+        # @return array|mixed
+        
+        def delete id
+            return make_request("#{self.endpoint}/#{id}/delete", {}, :delete)
+        end
+        
+    end
+end

data/lib/mautic_api/api/companies.rb

@@ -0,0 +1,11 @@
+module MauticApi
+
+    class Companies < Api
+      
+        ENDPOINT = 'companies'
+        LIST_NAME = "companies"
+        ITEM_NAME = "company"
+        
+    end
+  
+end

data/lib/mautic_api/api/contacts.rb

@@ -0,0 +1,96 @@
+module MauticApi
+
+    class Contacts < Api
+
+        ENDPOINT = "contacts"
+        LIST_NAME = "contacts"
+        ITEM_NAME = "contact"
+        
+        # Get a list of users available as contact owners
+        #
+        # @return array|mixed
+
+        def get_owners
+            return make_request("#{self.endpoint}/list/owners")
+        end
+
+        # Get a list of custom fields
+        #
+        # @return array|mixed
+
+        def get_field_list
+            return make_request("#{self.endpoint}/list/fields")
+        end
+
+        # Get a list of contact segments
+        #
+        # @return array|mixed
+
+        def get_segments
+            return make_request("#{self.endpoint}/list/segments")
+        end
+
+        # Get a list of a contact's notes
+        #
+        # @param int    $id Contact ID
+        # @param string $search
+        # @param int    $start
+        # @param int    $limit
+        # @param string $orderBy
+        # @param string $orderByDir
+        #
+        # @return array|mixed
+
+        def get_contact_notes id, search = '', start = 0, limit = 0, orderBy = '', order_by_dir = 'ASC'
+
+            parameters = {}
+
+            args = ['search', 'start', 'limit', 'orderBy', 'order_by_dir']
+
+            args.each do |arg|
+                parameters[arg.to_sym] = (eval arg) if (eval arg).present?
+            end
+
+            return make_request("#{self.endpoint}/#{id}/notes", parameters)
+        end
+
+        # Get a segment of smart segments the lead is in
+        #
+        # @param $id
+        # @return array|mixed
+
+        def get_contact_segments(id)
+            return make_request("#{self.endpoint}/#{id}/segments")
+        end
+
+        # Add do not contact to lead
+        #
+        # @param int    $id Contact ID
+        # @param string $comments
+        #
+        # @return array|mixed
+
+        def add_do_not_contact id, reason = 1, comments = ''
+            parameters = {}
+
+            args = ['reason', 'comments']
+
+            args.each do |arg|
+                parameters[arg.to_sym] = (eval arg) if (eval arg).present?
+            end
+
+            return make_request("#{self.endpoint}/#{id}/dnc/add/email", parameters, :post)
+        end
+
+        # Get a segment of campaigns the lead is in
+        #
+        # @param $id
+        # @return array|mixed
+
+        def get_contact_campaigns(id)
+            return make_request("#{self.endpoint}/#{id}/campaigns")
+        end
+
+    end
+
+end