kono_mailup 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5490a86115b7c60d580d9d2c245b3b69877f50e5
-  data.tar.gz: 582c527df50614e1b19a7b191081178fdec89a95
+  metadata.gz: 3f6e5c55e624989a65b2412be8af0ee4869ddee3
+  data.tar.gz: 5a074578cecaacf1118f0b980e65ed3d9f37c653
 SHA512:
-  metadata.gz: 38a4cb172052704977d7fb9f6f97ae0b31676541d086f5e0cd8b32fe97ad6491485b350d976e2951cb102bb0e1284a5c4bdea8465ef00711ba711b01e0cd3526
-  data.tar.gz: 9ffd1556ebd0a6e80c35f41e23747e713c3e8f413a31bc5a4b6b55e8216e51d7c47048edac5f5b764011d6a0c1f66dc8fd4b1dd8c77b64e3013c66637dc0c954
+  metadata.gz: ed61f652ddd1e2971fc44a95b1c1f66efa7fb6c7ade15710148bedde9b457ff3e1879be4ca5dc56411d09b0ab52a97ba04c3c69d5d54de68a91473922c5a7d5b
+  data.tar.gz: 8a670c52c54aad88ab87da3263214129e9e8ccb4d56399c38c3047f63f82b7b283cd18fcd2b9fdfe987f420ecde568468659229a935420feb1540194528b0e50

data/README.md

@@ -0,0 +1,24 @@
+**KonoMailup**
+
+**Description**<br>
+KonoMailup is a Mailup layer for rails applications that
+provides configuration and saving of user tokens; <br>
+with mailup gems for autentication/authorization and api connector
+
+
+**Installation**
+
+Add To your Gemfile
+
+     gem 'kono_mailup', '~> 0.0.1'
+     
+OR Install directly
+
+     gem install kono_mailup
+     
+Then in your rail application folder  
+
+     bin/rails g kono_mailup:install
+     bin/rake kono_mailup:install:migrations
+     
+Remember to configure the file created in the initilizers     

data/app/controllers/kono_mailup/application_controller.rb

@@ -1,3 +1,3 @@
-class KonoMailup::ApplicationController < ApplicationController
+class KonoMailup::ApplicationController < KonoMailup.base_controller.call
   protect_from_forgery with: :exception
 end

data/app/controllers/kono_mailup/tokens_controller.rb

@@ -1,15 +1,18 @@
-module KonoMailup
-  class TokensController < ApplicationController
+class KonoMailup::TokensController < KonoMailup::ApplicationController
 
-    def create
+  def create
 
-      API.save_tokens(token: request.env['omniauth.auth'][:credentials][:token],
-                      refresh_token: request.env['omniauth.auth'][:credentials][:refresh_token],
-                      expires_at: request.env['omniauth.auth'][:credentials][:expires_at])
+    KonoMailup::API.save_tokens(token: request.env['omniauth.auth'][:credentials][:token],
+                                refresh_token: request.env['omniauth.auth'][:credentials][:refresh_token],
+                                expires_at: request.env['omniauth.auth'][:credentials][:expires_at])
 
-      redirect_to root_path, notice: 'Successfully token configuration'
+    action_after_create
+  end
 
-    end
 
+  private
+  def action_after_create
+    redirect_to root_path, notice: 'Successfully token configuration'
   end
-end
+
+end

data/db/migrate/20171124083941_create_settings.rb

@@ -1,4 +1,4 @@
-class CreateSettings < ActiveRecord::Migration
+class CreateSettings < ActiveRecord::Migration[4.2]
   def self.up
     create_table :settings do |t|
       t.string  :var,        null: false

data/lib/generators/kono_mailup/install/install_generator.rb

@@ -3,16 +3,18 @@ module KonoMailup
     class InstallGenerator < Rails::Generators::Base
       source_root File.expand_path('../templates', __FILE__)
 
+      class_option :disable_routes, type: :boolean, default: false
+
       desc "Creates Initializers"
 
       def copy_initializer
 
         template "initializers.rb", "config/initializers/kono_mailup.rb"
 
-
-        route "get '/auth/mailup/callback', to: 'kono_mailup/sessions#create'"
-        route 'mount KonoMailup::Engine => "/kono_mailup"'
-
+        unless options['disable_routes']
+          route "get '/auth/mailup/callback', to: 'kono_mailup/tokens#create'"
+          route 'mount KonoMailup::Engine => "/kono_mailup"'
+        end
 
       end
 

data/lib/generators/kono_mailup/install/templates/initializers.rb

@@ -9,5 +9,9 @@ KonoMailup.setup do |config|
   # MAILUP_CLIENT_SECRET
   #config.mailup_client_secret = 'XXXXXXXXXX'
 
+  ##
+  # Controller from where the engine inherit
+  # config.base_controller = ApplicationController
+
 
 end

data/lib/kono_mailup.rb

@@ -22,6 +22,11 @@ module KonoMailup
   mattr_accessor :mailup_client_secret
   @@mailup_client_secret = 'XXXXXXXXXX'
 
+  ##
+  # Controller from where the engine inherit
+  mattr_accessor :base_controller
+  @@base_controller = Proc.new { ::ApplicationController }
+
 
   # Default way to setup KonoMailup. Run "rails generate kono_mailup_install" to create
   # a fresh initializer with all configuration values.

data/lib/kono_mailup/engine.rb

@@ -1,3 +1,7 @@
+#Remove this after using correct gems
+$:.unshift  File.expand_path("../../../vendor/omniauth-mailup/lib",__FILE__)
+$:.unshift  File.expand_path("../../../vendor/mailup-ruby/lib",__FILE__)
+
 module KonoMailup
   class Engine < ::Rails::Engine
     isolate_namespace KonoMailup

data/lib/kono_mailup/version.rb

@@ -1,3 +1,3 @@
 module KonoMailup
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 end

data/vendor/mailup-ruby/lib/mailup.rb

@@ -0,0 +1,229 @@
+require 'oauth2'
+require 'multi_json'
+require "net/https"
+require 'json'
+require "uri"
+
+require 'mailup/version'
+require 'mailup/errors'
+require 'mailup/console/base'
+require 'mailup/console/email'
+require 'mailup/console/group'
+require 'mailup/console/images'
+require 'mailup/console/import'
+require 'mailup/console/list'
+require 'mailup/console/recipient'
+require 'mailup/console/user'
+require 'mailup/public/base'
+require 'mailup/public/console'
+require 'mailup/stats/base'
+require 'mailup/stats/message'
+require 'mailup/stats/recipient'
+
+module MailUp
+  class API
+    attr_accessor :access_token, :debug, :host, :path, :credentials
+
+    # Initialize a new (thread-safe) API instance.
+    #
+    # @param [Hash] credentials for connecting to the MailUp API.
+    #   * client_id [String]
+    #   * client_secret [String]
+    #   * oauth [Hash]
+    #     * token [String]
+    #     * refresh_token [String]
+    #     * expires_at [Integer]
+    # @param [Boolean] debug whether or not to raise errors.
+    #
+    # @example
+    #
+    #   credentials = {
+    #     client_id: "1324567890",
+    #     client_secret: "123abc456def",
+    #     oauth: {
+    #       token: "1324567890",
+    #       refresh_token: "1324567890",
+    #       expires_at: 123456789,
+    #     }
+    #   }
+    #   mailup = MailUp::API.new(credentials)
+    #
+    def initialize(credentials=nil, debug=false)
+      @debug = debug
+      @host = 'https://services.mailup.com'
+      @path = ''
+      @credentials = credentials
+
+      # Validate the credentials
+      raise Error.new, 'MailUp credentials missing' if credentials.nil? or !credentials.is_a?(Hash)
+      [:client_id, :client_secret, :oauth].each do |key|
+        raise Error.new, "MailUp credentials must include a #{key.to_s} key" unless credentials.has_key?(key)
+      end
+      raise Error.new, 'MailUp credentials :oauth must be a hash' unless credentials[:oauth].is_a?(Hash)
+      [:token, :refresh_token, :expires_at].each do |key|
+        raise Error.new, "MailUp credentials :oauth hash must include a #{key.to_s} key" unless credentials[:oauth].has_key?(key)
+      end
+
+      # Create a OAuth2 client instance
+      client = OAuth2::Client.new(
+        credentials[:client_id],
+        credentials[:client_secret],
+        site: @host,
+        authorize_url: "/Authorization/OAuth/LogOn",
+        token_url: "/Authorization/OAuth/Token",
+        raise_errors: @debug
+      )
+
+      # Create an access_token instance
+      @access_token = OAuth2::AccessToken.new(
+        client,
+        credentials[:oauth][:token],
+        {
+          refresh_token: credentials[:oauth][:refresh_token],
+          expires_at: credentials[:oauth][:expires_at]
+        }
+      )
+    end
+
+    # Make a request with the Access Token.
+    #
+    # @param [Symbol] verb the HTTP request method
+    # @param [String] path the HTTP URL path of the request
+    # @param [Hash] opts the options to make the request with
+    #
+    def request(method, path, opts={}, &block) # :nodoc:
+      unless @access_token == nil
+        # Refresh token if needed
+        @access_token = @access_token.refresh! if @access_token.expired?
+        # Ensure the body is JSON
+        opts[:body] = MultiJson.dump(opts[:body]) if opts[:body]
+        # Set the headers
+        opts[:headers] ||= {}
+        opts[:headers].merge!(headers)
+        # Make the request
+        req = @access_token.send(method, path, opts)
+        # Handle the response
+        handle_response(req)
+      end
+    end
+
+    # Make a request with for Provisioning Calls.
+    #
+    # @param [Symbol] verb the HTTP request method
+    # @param [String] path the HTTP URL path of the request
+    # @param [Hash] opts the options to make the request with
+    #
+    def provisioning_request(path, body = nil) # :nodoc:
+      uri = URI.parse(@host)
+      http = Net::HTTP.new(uri.host, uri.port)
+      http.use_ssl = true
+      http.verify_mode = OpenSSL::SSL::VERIFY_PEER
+
+      req = Net::HTTP::Post.new(path, initheader = {'Content-Type' =>'application/json'})
+      req.basic_auth @credentials[:client_id], @credentials[:client_secret]
+      req.body = body.to_json
+
+      http.request(req).body.to_json
+    end
+
+    # Make a GET request with the Access Token
+    # @see #request
+    #
+    def get(path, opts={}, &block) # :nodoc:
+      request(:get, path, opts, &block)
+    end
+
+    # Make a POST request with the Access Token
+    # @see #request
+    #
+    def post(path, opts={}, &block) # :nodoc:
+      request(:post, path, opts, &block)
+    end
+
+    # Make a PUT request with the Access Token
+    # @see #request
+    #
+    def put(path, opts={}, &block) # :nodoc:
+      request(:put, path, opts, &block)
+    end
+
+    # Make a PATCH request with the Access Token
+    # @see #request
+    #
+    def patch(path, opts={}, &block) # :nodoc:
+      request(:patch, path, opts, &block)
+    end
+
+    # Make a DELETE request with the Access Token
+    # @see #request
+    #
+    def delete(path, opts={}, &block) # :nodoc:
+      request(:delete, path, opts, &block)
+    end
+
+    # Handle the response of a request
+    def handle_response(response) # :nodoc:
+      case response.status
+      when 400
+        raise BadRequest.new response.parsed
+      when 401
+        raise Unauthorized.new
+      when 404
+        raise NotFound.new
+      when 400...500
+        raise ClientError.new response.parsed
+      when 500...600
+        raise ServerError.new
+      else
+        case response.body
+        when ''
+          true
+        when is_a?(Integer)
+          response.body
+        else
+          response.parsed
+        end
+      end
+    end
+
+    # Set the request headers
+    def headers # :nodoc:
+      {
+        'User-Agent' => "mailup-ruby-#{VERSION}",
+        'Content-Type' => 'application/json; charset=utf-8',
+        'Accept' => 'application/json'
+      }
+    end
+
+    # Access the console API methods
+    #
+    # @example
+    #
+    #   lists = mailup.console.user.lists
+    #
+    def console
+      Console::Base.new self
+    end
+
+    # Access the public API methods
+    #
+    # @example
+    #
+    #   activation = mailup.public.activation.new(...)
+    #
+    def public
+      Public::Base.new self
+    end
+
+    # Access the email statistics API methods
+    #
+    # @example
+    #
+    #   views = mailup.stats.message.views_count(1)
+    #
+    def stats
+      Stats::Base.new self
+    end
+
+  end
+end

data/vendor/mailup-ruby/lib/mailup/console/base.rb

@@ -0,0 +1,115 @@
+module MailUp
+  module Console
+    class Base
+      attr_accessor :api
+
+      def initialize(api) # :nodoc:
+          @api = api
+          @api.path = "/API/v#{MailUp::API_VERSION}/Rest/ConsoleService.svc/Console"
+      end
+
+      # Create an email object
+      #
+      # @return [MailUp::Console::Email] 
+      #
+      # @example
+      #
+      #   email = mailup.console.email
+      #
+      def email
+        Email.new @api
+      end
+
+      # Create a group object
+      # 
+      # @param [Integer] id The group_id of the group to access.
+      #
+      # @return [MailUp::Console::Group] 
+      #
+      # @example
+      #
+      #   group = mailup.console.group(1)
+      #
+      def group(id)
+        Group.new id, @api
+      end
+
+      # Create an images object
+      #
+      # @return [MailUp::Console::Images] 
+      #
+      # @example
+      #
+      #   images = mailup.console.images
+      #
+      def images
+        Images.new @api
+      end
+      
+      # Create an import object
+      # 
+      # @param [Integer] idImport The ID of the import process.
+      #
+      # @return [MailUp::Console::Import] 
+      #
+      # @example
+      #
+      #   import = mailup.console.import(9)
+      #
+      def import(id)
+        Import.new id, @api
+      end
+
+      # Create a list object
+      # 
+      # @param [Integer] id The list_id of the list to access.
+      #
+      # @return [MailUp::Console::List] 
+      #
+      # @example
+      #
+      #   list = mailup.console.list(2)
+      #
+      def list(id)
+        List.new id, @api
+      end
+
+      # Create a public methods object
+      #
+      # @return [MailUp::Console::List] 
+      #
+      # @example
+      #
+      #   list = mailup.console.list(2)
+      #
+      def public
+        Public::Base.new @api
+      end
+
+      # Create a recipient object
+      #
+      # @return [MailUp::Console::Recipient] 
+      #
+      # @example
+      #
+      #   recipient = mailup.console.recipient
+      #
+      def recipient
+        Recipient.new @api
+      end
+
+      # Create a user object
+      #
+      # @return [MailUp::Console::User] 
+      #
+      # @example
+      #
+      #   user = mailup.console.user
+      #
+      def user
+        User.new @api
+      end
+
+    end
+  end
+end