pepipost_sdk_ruby 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: d372b00fe45332db359c58409f8a356b2e444707
+  data.tar.gz: 1e4dc84377829bf80a20e0c6fa4c1006da8ce1a4
+SHA512:
+  metadata.gz: 347b59c6b1a3d5a608aedc2e7b0b18f600a8feab9ea94eb6b0b0d1666be8b654205271ee474d4ea5edea55c84a4abbf0a5e82bfc4471a1ba7b2773087fd52b5d
+  data.tar.gz: d59b2e7800c54910a6eb71ddf43bbdd0103325ad974c87c108ae193db2741015301235a72921fe520722e1a1d4a071a6185711bdbd8ce0e024caddce075392b8

data/LICENSE

@@ -0,0 +1,25 @@
+License: 
+========
+The MIT License (MIT)
+http://opensource.org/licenses/MIT
+
+Copyright (c) 2014 - 2016 Pepipost
+
+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,49 @@
+Pepipost SDK - Ruby
+=================
+This is the official Pepipost SDK for Ruby. 
+
+It requires Ruby 2+
+
+This SDK requires the Unirest library.
+
+Installation: 
+=============
+Run the build command
+
+```
+gem build pepipost_apiv_10.gemspec
+```
+
+Run the install command  
+```
+gem install ./pepipost_apiv_10-1.0.0.gem
+```
+Usage:
+===========
+```ruby
+require 'pepipost_apiv_10'
+
+data = { 
+    "api_key"=>"yoursecretapikey",
+    "recipients"=> ["recipient1@example.com","recipient2@example.com"],
+    "email_details" => {
+        "fromname" => "sender name",
+        "subject" => "This is a test email sent usig Pepipost SDK for Ruby",
+        "from" => "from@example.com",
+        "content" => "<p>This is a test email sent using Pepipost SDK for Ruby</p>",
+    }   
+}
+
+
+email = PepipostApiv10::Email.new 
+response = email.send data
+
+print response
+
+```
+
+## Author
+
+[Tabby/Pepipost Devs](http://github.com/itabrezshaikh)
+
+This SDK was semi-automatically generated by APIMATIC v2.0. Thanks to [APIMATIC](http://apimatic.io/)

data/lib/pepipost_sdk_ruby.rb

@@ -0,0 +1,20 @@
+# This file was automatically generated by APIMATIC v2.0 on 04/15/2016
+require 'openssl'
+require 'json'
+require 'unirest'
+
+# APIMATIC Helper Files
+require 'pepipost_sdk_ruby/api_helper.rb'
+require 'pepipost_sdk_ruby/api_exception.rb'
+require 'pepipost_sdk_ruby/configuration.rb'
+require 'pepipost_sdk_ruby/pepipost_sdk_ruby_client.rb'
+
+# Controllers
+require 'pepipost_sdk_ruby/controllers/email_controller.rb'
+
+# Models
+require 'pepipost_sdk_ruby/models/attributes.rb'
+require 'pepipost_sdk_ruby/models/files.rb'
+require 'pepipost_sdk_ruby/models/emailv_1.rb'
+require 'pepipost_sdk_ruby/models/email_details.rb'
+require 'pepipost_sdk_ruby/models/settings.rb'

data/lib/pepipost_sdk_ruby/api_exception.rb

@@ -0,0 +1,21 @@
+# This file was automatically generated by APIMATIC v2.0 on 04/15/2016
+
+module PepipostSdkRuby
+  class APIException < StandardError
+    # value store
+    attr_reader :response_code
+
+    # value store
+    attr_reader :response_body
+
+    # The HTTP response code from the API request
+    # @param [String] the reason for raising an exception
+    # @param [Numeric] the HTTP response code from the API request
+    # @param [Object] the HTTP unprased response from the API request
+    def initialize(reason, response_code, response_body)
+      super(reason)
+      @response_code = response_code
+      @response_body = response_body
+    end
+  end
+end

data/lib/pepipost_sdk_ruby/api_helper.rb

@@ -0,0 +1,76 @@
+# This file was automatically generated by APIMATIC v2.0 on 04/15/2016
+
+module PepipostSdkRuby
+  class APIHelper
+    # Replaces template parameters in the given url
+    # @param [String] The query string builder to replace the template parameters
+    # @param [Array] The parameters to replace in the url
+    def self.append_url_with_template_parameters(query_builder, parameters)
+      # perform parameter validation
+      raise ArgumentError, 'Given value for parameter \"query_builder\" is invalid.' unless query_builder.is_a? String
+
+      # return if there are no parameters to replace
+      abort('no parameters to append') if parameters.nil?
+
+      # iterate and append parameters
+      parameters.map do |key, value|
+        replace_value = ''
+
+        if value.nil?
+          replace_value = ''
+        elsif value.is_a? Enumerable
+          replace_value = value.join('/')
+        else
+          replace_value = value.to_s
+        end
+
+        # find the template parameter and replace it with its value
+        query_builder = query_builder.gsub('{' + key.to_s + '}', replace_value)
+      end
+
+      query_builder
+    end
+
+    # Appends the given set of parameters to the given query string
+    # @param [String] The query string builder to replace the template parameters
+    # @param [Array] The parameters to append
+    def self.append_url_with_query_parameters(query_builder, parameters)
+      # perform parameter validation
+      raise ArgumentError, 'Given value for parameter \"query_builder\" is invalid.' unless query_builder.is_a? String
+
+      # return if there are no parameters to replace
+      abort('no parameters to append') if parameters.nil?
+
+      # remove any nil values
+      parameters = parameters.reject { |_key, value| value.nil? }
+
+      # does the query string already has parameters
+      has_params = query_builder.include? '?'
+      separator = has_params ? '&' : '?'
+
+      # append query with separator and parameters
+      query_builder << separator << URI.unescape(URI.encode_www_form(parameters))
+    end
+
+    # Validates and processes the given Url
+    # @param [String] The given Url to process
+    # @return [String] Pre-processed Url as string
+    def self.clean_url(url)
+      # perform parameter validation
+      raise ArgumentError, 'Invalid Url.' unless url.is_a? String
+
+      # ensure that the urls are absolute
+      matches = url.match(%r{^(https?:\/\/[^\/]+)})
+      raise ArgumentError, 'Invalid Url format.' if matches.nil?
+
+      # get the http protocol match
+      protocol = matches[1]
+
+      # remove redundant forward slashes
+      query = url[protocol.length..-1].gsub(%r{\/\/+}, '/')
+
+      # return process url
+      protocol + query
+    end
+  end
+end

data/lib/pepipost_sdk_ruby/configuration.rb

@@ -0,0 +1,14 @@
+# This file was automatically generated by APIMATIC v2.0 on 04/15/2016
+
+module PepipostSdkRuby
+  class Configuration
+    # The base Uri for API calls
+    @base_uri = 'https://api.pepipost.com'
+
+    # create the getters and setters
+    class << self
+      attr_accessor :base_uri
+
+    end
+  end
+end

data/lib/pepipost_sdk_ruby/controllers/email_controller.rb

@@ -0,0 +1,113 @@
+# This file was automatically generated by APIMATIC v2.0 on 04/15/2016
+
+module PepipostSdkRuby
+  class Email
+    @@instance = Email.new
+    # Singleton instance of the controller class
+    def self.instance
+      @@instance
+    end
+
+    # `Sending Mails` – This API is used for sending emails. Pepipost supports REST as well JSON formats for the input
+    # @param [String] api_key Required parameter: Your API Key
+    # @param [String] content Required parameter: Email body in html (to use attributes to display dynamic values such as name, account number, etc. for ex. [% NAME %] for ATT_NAME , [% AGE %] for ATT_AGE etc.)
+    # @param [String] from Required parameter: From email address
+    # @param [String] recipients Required parameter: Email addresses for recipients (multiple values allowed)
+    # @param [String] subject Required parameter: Subject of the Email
+    # @param [String] att_name Optional parameter: Specify attributes followed by ATT_ for recipient to personalized email for ex. ATT_NAME for name, ATT_AGE for age etc. (Multiple attributes are allowed)
+    # @param [String] attachmentid Optional parameter: specify uploaded attachments id (Multiple attachments are allowed)
+    # @param [String] bcc Optional parameter: Email address for bcc
+    # @param [Boolean] clicktrack Optional parameter: set ‘0’ or ‘1’ in-order to disable or enable the click-track
+    # @param [Boolean] footer Optional parameter: Set '0' or '1' in order to include footer or not
+    # @param [String] fromname Optional parameter: Email Sender name
+    # @param [Boolean] opentrack Optional parameter: set open-track value to ‘0’ or ‘1’ in-order to disable or enable
+    # @param [String] replytoid Optional parameter: Reply to email address
+    # @param [String] tags Optional parameter: To relate each message. Useful for reports.
+    # @param [Numeric] template Optional parameter: Email template ID
+    # @param [String] x_apiheader Optional parameter: Your defined unique identifier
+    # @return mixed response from the API call
+    def get_api_web_send_rest(api_key, content, from, recipients, subject, att_name = nil, attachmentid = nil, bcc = nil, clicktrack = true, footer = true, fromname = nil, opentrack = true, replytoid = nil, tags = nil, template = nil, x_apiheader = nil)
+      # the base uri for api requests
+      query_builder = Configuration.base_uri.dup
+
+      # prepare query string for API call
+      query_builder << '/api/web.send.rest'
+
+      # process optional query parameters
+      query_builder = APIHelper.append_url_with_query_parameters query_builder, {
+        'api_key' => api_key,
+        'content' => content,
+        'from' => from,
+        'recipients' => recipients,
+        'subject' => subject,
+        'ATT_NAME' => att_name,
+        'attachmentid' => attachmentid,
+        'bcc' => bcc,
+        'clicktrack' => if clicktrack.nil? then true else clicktrack end,
+        'footer' => if footer.nil? then true else footer end,
+        'fromname' => fromname,
+        'opentrack' => if opentrack.nil? then true else opentrack end,
+        'replytoid' => replytoid,
+        'tags' => tags,
+        'template' => template,
+        'X-APIHEADER' => x_apiheader
+      }
+
+      # validate and preprocess url
+      query_url = APIHelper.clean_url query_builder
+
+      # prepare headers
+      headers = {
+        'user-agent' => 'pepipost-sdk-ruby',
+        'accept' => 'application/json'
+      }
+
+      # invoke the API call request to fetch the response
+      response = Unirest.get query_url, headers: headers
+
+      #Error handling using HTTP status codes
+      if !response.code.between?(200, 206) # [200,206] = HTTP OK
+        raise APIException.new 'HTTP Response Not OK', response.code, response.raw_body
+      end
+
+      response.body
+    end
+
+    # This is a common function send email using Pepipost API
+    def send(data)
+        response = self.create_api_web_send_json(data)
+        return response
+    end
+
+    # `Sending Mails` – This API is used for sending emails. Pepipost supports REST as well JSON formats for the input. This is JSON API.
+    # @param [Emailv1] data Required parameter: Data in JSON format
+    # @return mixed response from the API call
+    def create_api_web_send_json(data)
+      # the base uri for api requests
+      query_builder = Configuration.base_uri.dup
+
+      # prepare query string for API call
+      query_builder << '/api/web.send.json'
+
+      # validate and preprocess url
+      query_url = APIHelper.clean_url query_builder
+
+      # prepare headers
+      headers = {
+        'user-agent' => 'pepipost-sdk-ruby',
+        'accept' => 'application/json',
+        'content-type' => 'application/json; charset=utf-8'
+      }
+
+      # invoke the API call request to fetch the response
+      response = Unirest.post query_url, headers: headers, parameters: data.to_json
+
+      #Error handling using HTTP status codes
+      if !response.code.between?(200, 206) # [200,206] = HTTP OK
+        raise APIException.new 'HTTP Response Not OK', response.code, response.raw_body
+      end
+
+      response.body
+    end
+  end
+end

data/lib/pepipost_sdk_ruby/models/attributes.rb

@@ -0,0 +1,31 @@
+# This file was automatically generated by APIMATIC v2.0 on 04/15/2016
+
+module PepipostSdkRuby
+  class Attributes
+    # TODO: Write general description for this method
+    # @return [Array<String>]
+    attr_accessor :name
+
+    # TODO: Write general description for this method
+    # @return [Array<String>]
+    attr_accessor :regid
+
+    def method_missing(method_name)
+      puts "there's no method called '#{method_name}'"
+    end
+
+    # Creates JSON of the curent object
+    def to_json
+      hash = key_map
+      hash.to_json
+    end
+
+    # Defines the key map for json serialization
+    def key_map
+      hash = {}
+      hash['NAME'] = name
+      hash['REGID'] = regid
+      hash
+    end
+  end
+end

data/lib/pepipost_sdk_ruby/models/email_details.rb

@@ -0,0 +1,51 @@
+# This file was automatically generated by APIMATIC v2.0 on 04/15/2016
+
+module PepipostSdkRuby
+  class EmailDetails
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :fromname
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :subject
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :from
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :replytoid
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :tags
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :content
+
+    def method_missing(method_name)
+      puts "there's no method called '#{method_name}'"
+    end
+
+    # Creates JSON of the curent object
+    def to_json
+      hash = key_map
+      hash.to_json
+    end
+
+    # Defines the key map for json serialization
+    def key_map
+      hash = {}
+      hash['fromname'] = fromname
+      hash['subject'] = subject
+      hash['from'] = from
+      hash['replytoid'] = replytoid
+      hash['tags'] = tags
+      hash['content'] = content
+      hash
+    end
+  end
+end

data/lib/pepipost_sdk_ruby/models/emailv_1.rb

@@ -0,0 +1,56 @@
+# This file was automatically generated by APIMATIC v2.0 on 04/15/2016
+
+module PepipostSdkRuby
+  class Emailv1
+    # Your secret API Key
+    # @return [String]
+    attr_accessor :api_key
+
+    # TODO: Write general description for this method
+    # @return [EmailDetails]
+    attr_accessor :email_details
+
+    # TODO: Write general description for this method
+    # @return [Array<String>]
+    attr_accessor :x_apiheader
+
+    # TODO: Write general description for this method
+    # @return [Settings]
+    attr_accessor :settings
+
+    # TODO: Write general description for this method
+    # @return [Array<String>]
+    attr_accessor :recipients
+
+    # TODO: Write general description for this method
+    # @return [Attributes]
+    attr_accessor :attributes
+
+    # TODO: Write general description for this method
+    # @return [Files]
+    attr_accessor :files
+
+    def method_missing(method_name)
+      puts "there's no method called '#{method_name}'"
+    end
+
+    # Creates JSON of the curent object
+    def to_json
+      hash = key_map
+      hash.to_json
+    end
+
+    # Defines the key map for json serialization
+    def key_map
+      hash = {}
+      hash['api_key'] = api_key
+      hash['email_details'] = email_details
+      hash['X-APIHEADER'] = x_apiheader
+      hash['settings'] = settings
+      hash['recipients'] = recipients
+      hash['attributes'] = attributes
+      hash['files'] = files
+      hash
+    end
+  end
+end

data/lib/pepipost_sdk_ruby/models/files.rb

@@ -0,0 +1,26 @@
+# This file was automatically generated by APIMATIC v2.0 on 04/15/2016
+
+module PepipostSdkRuby
+  class Files
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :example_attachment_1_txt
+
+    def method_missing(method_name)
+      puts "there's no method called '#{method_name}'"
+    end
+
+    # Creates JSON of the curent object
+    def to_json
+      hash = key_map
+      hash.to_json
+    end
+
+    # Defines the key map for json serialization
+    def key_map
+      hash = {}
+      hash['example_attachment1.txt'] = example_attachment_1_txt
+      hash
+    end
+  end
+end

data/lib/pepipost_sdk_ruby/models/settings.rb

@@ -0,0 +1,63 @@
+# This file was automatically generated by APIMATIC v2.0 on 04/15/2016
+
+module PepipostSdkRuby
+  class Settings
+    # TODO: Write general description for this method
+    # @return [Boolean]
+    attr_accessor :footer
+
+    # TODO: Write general description for this method
+    # @return [Boolean]
+    attr_accessor :clicktrack
+
+    # TODO: Write general description for this method
+    # @return [Boolean]
+    attr_accessor :opentrack
+
+    # TODO: Write general description for this method
+    # @return [Boolean]
+    attr_accessor :unsubscribe
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :bcc
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :attachmentid
+
+    # TODO: Write general description for this method
+    # @return [Numeric]
+    attr_accessor :template
+
+    def initialize
+      @footer = true
+      @clicktrack = true
+      @opentrack = true
+      @unsubscribe = true
+    end
+
+    def method_missing(method_name)
+      puts "there's no method called '#{method_name}'"
+    end
+
+    # Creates JSON of the curent object
+    def to_json
+      hash = key_map
+      hash.to_json
+    end
+
+    # Defines the key map for json serialization
+    def key_map
+      hash = {}
+      hash['footer'] = footer
+      hash['clicktrack'] = clicktrack
+      hash['opentrack'] = opentrack
+      hash['unsubscribe'] = unsubscribe
+      hash['bcc'] = bcc
+      hash['attachmentid'] = attachmentid
+      hash['template'] = template
+      hash
+    end
+  end
+end

data/lib/pepipost_sdk_ruby/pepipost_sdk_ruby_client.rb

@@ -0,0 +1,16 @@
+# This file was automatically generated by APIMATIC v2.0 on 04/15/2016
+
+# Require controllers
+#require '/var/lib/gems/2.2.0/gems/pepipost_apiv_10-1.0.0/lib/pepipost_apiv_10/controllers/email_controller.rb'
+require 'pepipost_sdk_ruby/controllers/email_controller.rb'
+
+module PepipostSdkRuby
+  class PepipostSdkRubyClient
+    # Singleton access to email controller
+    # @return [EmailController] Returns the controller instance
+    def email
+      EmailController.instance
+    end
+
+  end
+end

metadata

@@ -0,0 +1,70 @@
+--- !ruby/object:Gem::Specification
+name: pepipost_sdk_ruby
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Tabrez Shaikh
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-09-03 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: unirest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.1.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.1.2
+description: This is the Official Pepipost SDK for Ruby
+email: tabrez@pepipost.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- lib/pepipost_sdk_ruby.rb
+- lib/pepipost_sdk_ruby/api_exception.rb
+- lib/pepipost_sdk_ruby/api_helper.rb
+- lib/pepipost_sdk_ruby/configuration.rb
+- lib/pepipost_sdk_ruby/controllers/email_controller.rb
+- lib/pepipost_sdk_ruby/models/attributes.rb
+- lib/pepipost_sdk_ruby/models/email_details.rb
+- lib/pepipost_sdk_ruby/models/emailv_1.rb
+- lib/pepipost_sdk_ruby/models/files.rb
+- lib/pepipost_sdk_ruby/models/settings.rb
+- lib/pepipost_sdk_ruby/pepipost_sdk_ruby_client.rb
+homepage: http://pepipost.com/
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - "~>"
+    - !ruby/object:Gem::Version
+      version: '2.0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.5.1
+signing_key: 
+specification_version: 4
+summary: pepipost_sdk_ruby
+test_files: []