mautic_api 1.0.0

data/lib/mautic_api/api/segments.rb

@@ -0,0 +1,33 @@
+module MauticApi
+
+  class Segments < Api
+    
+    ENDPOINT = "segments"
+    LIST_NAME = "segments"
+    ITEM_NAME = "segment"
+    
+    # Add a contact to the segment
+    #
+    # @param int $id      Segment ID
+    # @param int $contactId Contact ID
+    #
+    # @return array|mixed
+    
+    def add_contact id, contact_id
+      return make_request("#{self.endpoint}/#{id}/contact/add/#{contact_id}", {}, :post)
+    end
+
+    # Remove a contact from the segment
+    #
+    # @param int $id      Segment ID
+    # @param int $contactId Contact ID
+    #
+    # @return array|mixed
+    
+    def remove_contact id, contact_id
+      return make_request("#{self.endpoint}/#{id}/contact/remove/#{contact_id}", {}, :post)
+    end
+
+  end
+  
+end

data/lib/mautic_api/auth/abstract_auth.rb

@@ -0,0 +1,258 @@
+
+# @copyright   2017 Mautic Contributors. All rights reserved
+# @author      Mautic, Inc.
+#
+# @link        https://mautic.org
+#
+# @license     GNU/GPLv3 http://www.gnu.org/licenses/gpl-3.0.html
+ 
+module MauticApi::Auth
+
+    # use Mautic\Exception\UnexpectedResponseFormatException
+    # use Mautic\Response
+
+    class AbstractAuth < AuthInterface
+
+#         # Holds string of HTTP response headers
+#         #
+#         # @var string
+        
+#         attr_protected :_http_response_headers
+
+#         # Holds array of HTTP response CURL info
+#         #
+#         # @var array
+        
+#         attr_protected :_http_response_info
+
+#         # Timeout for a cURL request
+#         #
+#         # @var int
+        
+#         attr_protected :_curl_timeout = null
+        
+
+#         # Returns array of HTTP response headers
+#         #
+#         # @return array
+        
+#         def get_response_headers()
+#         {
+#             return self.parse_headers(self._http_response_headers)
+#         }
+            
+#         # Returns array of HTTP response headers
+#         #
+#         # @return array
+        
+#         def get_response_info()
+#         {
+#             return self._http_response_info
+#         }
+        
+#         # {@inheritdoc}
+#         #
+#         # @throws UnexpectedResponseFormatException|Exception
+        
+#         def makeRequest url, parameters = [], method = :get, settings = []
+        
+#             # self.log('makeRequest('.$url.', '.http_build_query($parameters).', '.$method.',...)')
+#             url, parameters = self.separate_url_params(url, parameters)
+
+#             # make sure method is capitalized for congruency
+#             method = method.underscore
+
+#             headers = settings['headers'] || {}
+#             headers, parameters = self.prepare_request url, headers, parameters, method, settings
+
+#             # Set default CURL options
+#             options = {
+#                 CURLOPT_RETURNTRANSFER: true,
+#                 CURLOPT_SSL_VERIFYPEER: false,
+#                 CURLOPT_HEADER: true
+#             }
+            
+
+#             if self._curl_timeout != nil
+#             $options[CURLOPT_TIMEOUT] = self._curlTimeout
+        
+#             // CURLOPT_FOLLOWLOCATION cannot be activated when an open_basedir is set
+#             $options[CURLOPT_FOLLOWLOCATION] = (ini_get('open_basedir')) ? false : true
+#             //Set custom REST method if not GET or POST
+#             if (!in_array($method, array('GET', 'POST'))) {
+#                 $options[CURLOPT_CUSTOMREQUEST] = $method
+#             }
+#             //Set post fields for POST/PUT/PATCH requests
+#             $isPost = false
+#             if (in_array($method, array('POST', 'PUT', 'PATCH'))) {
+#                 $isPost = true
+#                 // Set file to upload
+#                 // Sending file data requires an array to set
+#                 // the Content-Type header to multipart/form-data
+#                 if (!empty($parameters['file']) && file_exists($parameters['file'])) {
+#                     $options[CURLOPT_INFILESIZE] = filesize($parameters['file'])
+#                     $parameters['file']          = self.createCurlFile($parameters['file'])
+#                     $headers[]                   = "Content-Type: multipart/form-data"
+#                 } else {
+#                     $parameters = http_build_query($parameters, '', '&')
+#                 }
+#                 $options[CURLOPT_POST]       = true
+#                 $options[CURLOPT_POSTFIELDS] = $parameters
+#                 self.log('Posted parameters = '.print_r($parameters, true))
+#             }
+#             $query = self.getQueryParameters($isPost, $parameters)
+#             self.log('Query parameters = '.print_r($query, true))
+#             //Create a query string for GET/DELETE requests
+#             if (count($query) > 0) {
+#                 $queryGlue = strpos($url, '?') === false ? '?' : '&'
+#                 $url       = $url.$queryGlue.http_build_query($query, '', '&')
+#                 self.log('URL updated to '.$url)
+#             }
+#             // Set the URL
+#             $options[CURLOPT_URL] = $url
+#             $headers[]                   = 'Accept: application/json'
+#             $options[CURLOPT_HTTPHEADER] = $headers
+#             //Make CURL request
+#             $curl = curl_init()
+#             curl_setopt_array($curl, $options)
+#             $response = new Response(curl_exec($curl), curl_getinfo($curl))
+#             self._httpResponseHeaders = $response->getHeaders()
+#             self._httpResponseInfo    = $response->getInfo()
+#             curl_close($curl)
+#             if (self._debug) {
+#                 $_SESSION['oauth']['debug']['info']            = $response->getInfo()
+#                 $_SESSION['oauth']['debug']['returnedHeaders'] = $response->getHeaders()
+#                 $_SESSION['oauth']['debug']['returnedBody']    = $response->getBody()
+#             }
+#             // Handle zip file response
+#             if ($response->isZip()) {
+#                 $temporaryFilePath = isset($settings['temporaryFilePath']) ? $settings['temporaryFilePath'] : sys_get_temp_dir()
+#                 return $response->saveToFile($temporaryFilePath)
+#             } else {
+#                 return $response->getDecodedBody()
+#             }
+#         }
+
+
+#         protected
+
+#         # @param       $url
+#         # @param array $headers
+#         # @param array $parameters
+#         # @param       $method
+#         # @param array $settings
+#         #
+#         # @return mixed
+        
+#         def prepare_request url, headers, parameters, method, settings
+
+#         end
+
+
+#  # @deprecated 2.6.0 to be removed in 3.0; use createCurlFile instead
+#  #
+#  # @param        $filename
+#  # @param string $mimetype
+#  # @param string $postname
+#  #
+#  # @return \CURLFile|string
+
+# protected function crateCurlFile($filename, $mimetype = '', $postname = '')
+# {
+#     return self.createCurlFile($filename, $mimetype, $postname)
+# }
+
+#  # Build the CURL file based on PHP version
+#  #
+#  # @param  string $filename
+#  # @param  string $mimetype
+#  # @param  string $postname
+#  #
+#  # @return string|\CURLFile
+
+# protected function createCurlFile($filename, $mimetype = '', $postname = '')
+# {
+#     if (!function_exists('curl_file_create')) {
+#         // For PHP < 5.5
+#         return "@$filename;filename="
+#             .($postname ?: basename($filename))
+#             .($mimetype ? ";type=$mimetype" : '')
+#     }
+#     // For PHP >= 5.5
+#     return curl_file_create($filename, $mimetype, $postname)
+# }
+
+#  # @param $isPost
+#  # @param $parameters
+#  #
+#  # @return array
+
+# protected function getQueryParameters($isPost, $parameters)
+# {
+#     return ($isPost) ? array() : $parameters
+# }
+
+#  # @param string $message
+
+# protected function log($message)
+# {
+#     if (self._debug) {
+#         $_SESSION['oauth']['debug']['flow'][date('m-d H:i:s')][] = $message
+#     }
+# }
+
+#  # Build the HTTP response array out of the headers string
+#  #
+#  # @param  string $headersStr
+#  #
+#  # @return array
+
+# protected function parseHeaders($headersStr)
+# {
+#     $headersArr  = array()
+#     $headersHlpr = explode("\r\n", $headersStr)
+#     foreach ($headersHlpr as $header) {
+#         $pos = strpos($header, ':')
+#         if ($pos === false) {
+#             $headersArr[] = trim($header)
+#         } else {
+#             $headersArr[trim(substr($header, 0, $pos))] = trim(substr($header, ($pos + 1)))
+#         }
+#     }
+#     return $headersArr
+# }
+
+#  # Separates parameters from base URL
+#  #
+#  # @param $url
+#  # @param $params
+#  #
+#  # @return array
+
+# protected function separateUrlParams($url, $params)
+# {
+#     $a = parse_url($url)
+#     if (!empty($a['query'])) {
+#         parse_str($a['query'], $qparts)
+#         $cleanParams = array()
+#         foreach ($qparts as $k => $v) {
+#             $cleanParams[$k] = $v ? $v : ''
+#         }
+#         $params   = array_merge($params, $cleanParams)
+#         $urlParts = explode('?', $url, 2)
+#         $url      = $urlParts[0]
+#     }
+#     return array($url, $params)
+# }
+
+#  # Set the timeout for a cURL request
+#  #
+#  # @param int $timeout
+
+# public function setCurlTimeout($timeout)
+# {
+#     self._curlTimeout = $timeout
+# }
+
+    end
+end

data/lib/mautic_api/auth/api_auth.rb

@@ -0,0 +1,57 @@
+
+
+ # @copyright   2014 Mautic Contributors. All rights reserved
+ # @author      Mautic, Inc.
+ #
+ # @link        https://mautic.org
+ #
+ # @license     GNU/GPLv3 http://www.gnu.org/licenses/gpl-3.0.html
+
+module MauticApi::Auth
+  
+#         # OAuth Client modified from https://code.google.com/p/simple-php-oauth/
+
+    class ApiAuth
+        
+#             # Get an API Auth object
+#             #
+#             # @param array  $parameters
+#             # @param string auth_method
+#             #
+#             # @return AuthInterface
+#             #
+#             # @deprecated
+        
+#             def self.initialize parameters = [], auth_method = :o_auth
+#                 object = self.new
+#                 return object.new_auth parameters, auth_method
+#             end
+  
+#             # Get an API Auth object
+#             #
+#             # @param array  $parameters
+#             # @param string auth_method
+#             #
+#             # @return AuthInterface
+
+#             def new_auth parameters = {}, auth_method = :o_auth
+  
+#                 klass       = "MauticApi::Auth::#{auth_method.camelize}".constantize
+#                 auth_object = klass.new
+#                 auth_setup  = auth_object.method(:setup)
+#                 pass        = []
+
+#                 auth_setup.parameters.each do |method, param|
+#                     if parameters[param.to_sym]
+#                         pass << parameters[param.to_sym]
+#                     else
+#                         pass << nil
+#                     end
+#                 end
+
+#                 auth_setup.call(*pass)
+
+#                 return auth_object
+#             end
+    end
+end

data/lib/mautic_api/auth/auth.rb

@@ -0,0 +1,6 @@
+module MauticApi
+    module Auth
+        autoload :AuthInterface, 'mautic_api/auth/auth_interface'
+        autoload :OAuth2, 'mautic_api/auth/oauth2'
+    end
+end

data/lib/mautic_api/auth/auth_interface.rb

@@ -0,0 +1,29 @@
+
+module MauticApi::Auth
+
+    # OAuth Client modified from https://code.google.com/p/simple-php-oauth/
+
+    class AuthInterface
+
+        # Check if current authorization is still valid
+        #
+        # @return bool
+
+        def is_authorized
+            raise 'not implemented'
+        end
+
+        # Make a request to server using the supported auth method
+        #
+        # @param string $url
+        # @param array  $parameters
+        # @param string $method
+        # @param array  $settings
+        #
+        # @return array
+
+        def make_request url, parameters={}, method=:get, settings={}
+            raise 'not implemented'
+        end
+    end
+end

data/lib/mautic_api/auth/oauth2.rb

@@ -0,0 +1,62 @@
+
+# @copyright   2014 Mautic Contributors. All rights reserved
+# @author      Mautic, Inc.
+#
+# @link        https://mautic.org
+#
+# @license     GNU/GPLv3 http://www.gnu.org/licenses/gpl-3.0.html
+ 
+module MauticApi::Auth
+
+    class OAuth2 < AuthInterface
+
+        attr_accessor :access_token, :response_info
+
+        def initialize access_token, parameters={}
+            self.access_token = access_token
+        end
+
+        def is_authorized
+            #Check for existing access token
+            return self.access_token && !self.access_token.expired?
+        end
+
+        def get_response_info
+            self.response_info
+        end
+        
+        # Make a request to server using oauth2
+        #
+        # @param string $url
+        # @param array  $parameters
+        # @param string $method
+        # @param array  $settings
+        #
+        # @return array
+
+        def make_request url, parameters = {}, method = :get, settings = {}, &block
+            
+            case method
+            when :get
+                self.response_info = self.access_token.get(url, :params => parameters, &block)
+            when :post
+                self.response_info = self.access_token.post(url, :body => parameters, &block)
+            when :put
+                self.response_info = self.access_token.put(url, :body => parameters, &block)
+            when :patch
+                self.response_info = self.access_token.patch(url, :body => parameters, &block)
+            when :delete
+                self.response_info = self.access_token.delete(url, :body => parameters, &block)
+            end
+
+            return {
+                url: url,
+                method: method,
+                parameters: parameters,
+                settings: settings,
+                code: self.response_info.status,
+                body: self.response_info.parsed
+            }
+        end
+    end
+end