kono_mailup 0.0.1 → 0.0.2

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

@@ -0,0 +1,303 @@
+module MailUp
+  module Stats
+    class Recipient
+      attr_accessor :api
+
+      def initialize(id, api)
+          @api = api
+          @id = id
+      end
+
+      # Paged list of messages received by the specified recipient.
+      #
+      # @param [Hash] params Optional params or filters:
+      # @option params [Integer] :pageNumber The page number to return.
+      # @option params [Integer] :pageSize The number of results to per page.
+      # @option params [String] :filterby A filtering expression.
+      # @option params [String] :orderby The sorting condition for the results.
+      #
+      # @return [JSON] Results and data including:
+      #   * IsPaginated [Boolean]
+      #   * Items [Array<Hash>]
+      #   * PageNumber [Integer]
+      #   * PageSize [Integer]
+      #   * Skipped [Integer]
+      #   * TotalElementsCount [Integer]
+      #
+      # @see http://help.mailup.com/display/mailupapi/Email+statistics+methods+v1.1#Emailstatisticsmethodsv1.1-ListRecipientMessageDeliveries
+      #
+      # @example
+      #
+      #   deliveries = mailup.console.recipient(154).deliveries
+      #   deliveries['TotalElementsCount']
+      #   => 10
+      #   deliveries['Items'].first['Subject']
+      #   => "Message Subject"
+      #
+      def deliveries(params = {})
+        @api.get("#{@api.path}/Recipient/#{@id}/List/Deliveries", params: params)
+      end
+      
+      # Count of messages received by the specified recipient.
+      #
+      #
+      # @return [Integer] Count of deliveries.
+      #
+      # @see http://help.mailup.com/display/mailupapi/Email+statistics+methods+v1.1#Emailstatisticsmethodsv1.1-CountRecipientMessageDeliveries
+      #
+      # @example
+      #
+      #   deliveries = mailup.console.recipient(154).deliveries_count
+      #   => 324
+      #
+      def deliveries_count
+        @api.get("#{@api.path}/Recipient/#{@id}/Count/Deliveries")
+      end
+      
+      # Paged list of messages viewed by the specified recipient.
+      #
+      # @param [Hash] params Optional params or filters:
+      # @option params [Integer] :pageNumber The page number to return.
+      # @option params [Integer] :pageSize The number of results to per page.
+      # @option params [String] :filterby A filtering expression.
+      # @option params [String] :orderby The sorting condition for the results.
+      #
+      # @return [JSON] Results and data including:
+      #   * IsPaginated [Boolean]
+      #   * Items [Array<Hash>]
+      #   * PageNumber [Integer]
+      #   * PageSize [Integer]
+      #   * Skipped [Integer]
+      #   * TotalElementsCount [Integer]
+      #
+      # @see http://help.mailup.com/display/mailupapi/Email+statistics+methods+v1.1#Emailstatisticsmethodsv1.1-ListRecipientMessageViews
+      #
+      # @example
+      #
+      #   views = mailup.console.recipient(154).views
+      #   views['TotalElementsCount']
+      #   => 10
+      #   views['Items'].first['Subject']
+      #   => "Message Subject"
+      #
+      def views(params = {})
+        @api.get("#{@api.path}/Recipient/#{@id}/List/Views", params: params)
+      end
+      
+      # Count of messages viewed by the specified recipient.
+      #
+      #
+      # @return [Integer] Count of views.
+      #
+      # @see http://help.mailup.com/display/mailupapi/Email+statistics+methods+v1.1#Emailstatisticsmethodsv1.1-CountRecipientMessageViews
+      #
+      # @example
+      #
+      #   views = mailup.console.recipient(154).views_count
+      #   => 324
+      #
+      def views_count
+        @api.get("#{@api.path}/Recipient/#{@id}/Count/Views")
+      end
+      
+      # Paged list of bounces with details returned by the specified recipient.
+      #
+      # @param [Hash] params Optional params or filters:
+      # @option params [Integer] :pageNumber The page number to return.
+      # @option params [Integer] :pageSize The number of results to per page.
+      # @option params [String] :filterby A filtering expression.
+      # @option params [String] :orderby The sorting condition for the results.
+      #
+      # @return [JSON] Results and data including:
+      #   * IsPaginated [Boolean]
+      #   * Items [Array<Hash>]
+      #   * PageNumber [Integer]
+      #   * PageSize [Integer]
+      #   * Skipped [Integer]
+      #   * TotalElementsCount [Integer]
+      #
+      # @see http://help.mailup.com/display/mailupapi/Email+statistics+methods+v1.1#Emailstatisticsmethodsv1.1-ListRecipientMessageBouncesDetails
+      #
+      # @example
+      #
+      #   bounces = mailup.console.recipient(154).bounces_details
+      #   bounces['TotalElementsCount']
+      #   => 10
+      #   bounces['Items'].first['Subject']
+      #   => "Message Subject"
+      #
+      def bounces_details(params = {})
+        @api.get("#{@api.path}/Recipient/#{@id}/List/BouncesDetails", params: params)
+      end
+
+      # Paged list of bounces returned by the specified recipient.
+      #
+      # @param [Hash] params Optional params or filters:
+      # @option params [Integer] :pageNumber The page number to return.
+      # @option params [Integer] :pageSize The number of results to per page.
+      # @option params [String] :filterby A filtering expression.
+      # @option params [String] :orderby The sorting condition for the results.
+      #
+      # @return [JSON] Results and data including:
+      #   * IsPaginated [Boolean]
+      #   * Items [Array<Hash>]
+      #   * PageNumber [Integer]
+      #   * PageSize [Integer]
+      #   * Skipped [Integer]
+      #   * TotalElementsCount [Integer]
+      #
+      # @see http://help.mailup.com/display/mailupapi/Email+statistics+methods+v1.1#Emailstatisticsmethodsv1.1-ListRecipientMessageBounces
+      #
+      # @example
+      #
+      #   bounces = mailup.console.recipient(154).bounces
+      #   bounces['TotalElementsCount']
+      #   => 10
+      #   bounces['Items'].first['Subject']
+      #   => "Message Subject"
+      #
+      def bounces(params = {})
+        @api.get("#{@api.path}/Recipient/#{@id}/List/Bounces", params: params)
+      end
+      
+      # Count of bounces returned by the specified recipient.
+      #
+      #
+      # @return [Integer] Count of bounces.
+      #
+      # @see http://help.mailup.com/display/mailupapi/Email+statistics+methods+v1.1#Emailstatisticsmethodsv1.1-CountRecipientMessageBounces
+      #
+      # @example
+      #
+      #   views = mailup.console.recipient(154).bounces_count
+      #   => 324
+      #
+      def bounces_count
+        @api.get("#{@api.path}/Recipient/#{@id}/Count/Bounces")
+      end
+      
+      # Paged list of unsubscriptions done by the specified recipient.
+      #
+      # @param [Hash] params Optional params or filters:
+      # @option params [Integer] :pageNumber The page number to return.
+      # @option params [Integer] :pageSize The number of results to per page.
+      # @option params [String] :filterby A filtering expression.
+      # @option params [String] :orderby The sorting condition for the results.
+      #
+      # @return [JSON] Results and data including:
+      #   * IsPaginated [Boolean]
+      #   * Items [Array<Hash>]
+      #   * PageNumber [Integer]
+      #   * PageSize [Integer]
+      #   * Skipped [Integer]
+      #   * TotalElementsCount [Integer]
+      #
+      # @see http://help.mailup.com/display/mailupapi/Email+statistics+methods+v1.1#Emailstatisticsmethodsv1.1-ListRecipientUnsubscriptions
+      #
+      # @example
+      #
+      #   unsubscribes = mailup.console.recipient(154).unsubscribes
+      #   unsubscribes['TotalElementsCount']
+      #   => 10
+      #   unsubscribes['Items'].first['Subject']
+      #   => "Message Subject"
+      #
+      def unsubscribes(params = {})
+        @api.get("#{@api.path}/Recipient/#{@id}/List/Unsubscriptions", params: params)
+      end
+      
+      # Count of unsubscriptions done by the specified recipient.
+      #
+      #
+      # @return [Integer] Count of unsubscribes.
+      #
+      # @see http://help.mailup.com/display/mailupapi/Email+statistics+methods+v1.1#Emailstatisticsmethodsv1.1-CountRecipientUnsubscriptions
+      #
+      # @example
+      #
+      #   unsubscribes = mailup.console.recipient(154).unsubscribes_count
+      #   => 324
+      #
+      def unsubscribes_count
+        @api.get("#{@api.path}/Recipient/#{@id}/Count/Unsubscriptions")
+      end
+
+      # Verbose paged list of message clicks on a link done by the specified recipient.
+      #
+      # @param [Hash] params Optional params or filters:
+      # @option params [Integer] :pageNumber The page number to return.
+      # @option params [Integer] :pageSize The number of results to per page.
+      # @option params [String] :filterby A filtering expression.
+      # @option params [String] :orderby The sorting condition for the results.
+      #
+      # @return [JSON] Results and data including:
+      #   * IsPaginated [Boolean]
+      #   * Items [Array<Hash>]
+      #   * PageNumber [Integer]
+      #   * PageSize [Integer]
+      #   * Skipped [Integer]
+      #   * TotalElementsCount [Integer]
+      #
+      # @see http://help.mailup.com/display/mailupapi/Email+statistics+methods#Emailstatisticsmethods-ListRecipientClickDetailsByDate
+      #
+      # @example
+      #
+      #   clicks = mailup.console.recipient(154).clicks_details
+      #   clicks['TotalElementsCount']
+      #   => 10
+      #   clicks['Items'].first['Subject']
+      #   => "Message Subject"
+      #
+      def clicks_details(params = {})
+        @api.get("#{@api.path}/Recipient/#{@id}/List/ClicksDetails", params: params)
+      end
+      
+      # Paged list of message clicks on a link done by the specified recipient.
+      #
+      # @param [Hash] params Optional params or filters:
+      # @option params [Integer] :pageNumber The page number to return.
+      # @option params [Integer] :pageSize The number of results to per page.
+      # @option params [String] :filterby A filtering expression.
+      # @option params [String] :orderby The sorting condition for the results.
+      #
+      # @return [JSON] Results and data including:
+      #   * IsPaginated [Boolean]
+      #   * Items [Array<Hash>]
+      #   * PageNumber [Integer]
+      #   * PageSize [Integer]
+      #   * Skipped [Integer]
+      #   * TotalElementsCount [Integer]
+      #
+      # @see http://help.mailup.com/display/mailupapi/Email+statistics+methods+v1.1#Emailstatisticsmethodsv1.1-ListRecipientMessageClicks
+      #
+      # @example
+      #
+      #   clicks = mailup.console.recipient(154).clicks
+      #   clicks['TotalElementsCount']
+      #   => 10
+      #   clicks['Items'].first['Subject']
+      #   => "Message Subject"
+      #
+      def clicks(params = {})
+        @api.get("#{@api.path}/Recipient/#{@id}/List/Clicks", params: params)
+      end
+      
+      # Count of clicks on a link in the specified email.
+      #
+      #
+      # @return [Integer] Count of clicks.
+      #
+      # @see http://help.mailup.com/display/mailupapi/Email+statistics+methods+v1.1#Emailstatisticsmethodsv1.1-CountRecipientClicks
+      #
+      # @example
+      #
+      #   clicks = mailup.console.recipient(154).clicks_count
+      #   => 324
+      #
+      def clicks_count
+        @api.get("#{@api.path}/Recipient/#{@id}/Count/Clicks")
+      end
+
+    end
+  end
+end

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

@@ -0,0 +1,4 @@
+module MailUp
+  API_VERSION = "1.1"
+  VERSION = "1.2.0"
+end

data/vendor/mailup-ruby/rails/init.rb

@@ -0,0 +1 @@
+require 'mailup'

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

@@ -0,0 +1,2 @@
+require "omniauth-mailup/version"
+require "omniauth/strategies/mailup"

data/vendor/omniauth-mailup/lib/omniauth-mailup/version.rb

@@ -0,0 +1,5 @@
+module Omniauth
+  module MailUp
+    VERSION = "0.0.5"
+  end
+end

data/vendor/omniauth-mailup/lib/omniauth/strategies/mailup.rb

@@ -0,0 +1,41 @@
+require 'omniauth-oauth2'
+require 'multi_json'
+
+module OmniAuth
+  module Strategies
+    class MailUp < OmniAuth::Strategies::OAuth2
+      
+      option :name, :mailup
+
+      option :client_options, {
+        site: "https://services.mailup.com",
+        authorize_url: "/Authorization/OAuth/LogOn",
+        token_url: "/Authorization/OAuth/Token"
+      }
+      
+      # TODO: Do we need this?
+      option :provider_ignores_state, true
+
+      # AuthHash data for Omniauth
+      uid { raw_info["UID"] } # TODO: Need uid from MailUp
+      
+      info do
+        {
+          company: raw_info["Company"],
+          nickname: raw_info["Username"],
+          version: raw_info["Version"],
+          is_trial: raw_info["IsTrial"]
+        }
+      end
+      
+      # Get more information about the user.
+      def raw_info
+        req = access_token.get('/API/v1.1/Rest/ConsoleService.svc/Console/Authentication/Info')
+        @raw_info ||= MultiJson.load(req.body)
+      end
+    end
+  end
+end
+
+# Make sure that 'mailup' camelizes properly to 'MailUp'.
+OmniAuth.config.add_camelization 'mailup', 'MailUp'

metadata

@@ -1,57 +1,71 @@
 --- !ruby/object:Gem::Specification
 name: kono_mailup
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Marino Bonetti
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-11-24 00:00:00.000000000 Z
+date: 2017-11-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: oauth2
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 4.2.10
+        version: '1.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 4.2.10
+        version: '1.0'
 - !ruby/object:Gem::Dependency
-  name: mailup
+  name: omniauth-oauth2
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.2'
+        version: 1.3.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.2'
+        version: 1.3.0
 - !ruby/object:Gem::Dependency
-  name: omniauth-mailup
+  name: multi_json
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.0.5
+        version: '1.10'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.0.5
+        version: '1.10'
 - !ruby/object:Gem::Dependency
   name: rails-settings-cached
   requirement: !ruby/object:Gem::Requirement
@@ -119,9 +133,8 @@ extensions: []
 extra_rdoc_files: []
 files:
 - MIT-LICENSE
-- README.rdoc
+- README.md
 - Rakefile
-- app/assets/images/kono_mailup/.keep
 - app/assets/javascripts/kono_mailup/application.js
 - app/assets/stylesheets/kono_mailup/application.css
 - app/controllers/kono_mailup/application_controller.rb
@@ -192,6 +205,26 @@ files:
 - spec/dummy/public/422.html
 - spec/dummy/public/500.html
 - spec/dummy/public/favicon.ico
+- vendor/mailup-ruby/lib/mailup.rb
+- vendor/mailup-ruby/lib/mailup/console/base.rb
+- vendor/mailup-ruby/lib/mailup/console/email.rb
+- vendor/mailup-ruby/lib/mailup/console/group.rb
+- vendor/mailup-ruby/lib/mailup/console/images.rb
+- vendor/mailup-ruby/lib/mailup/console/import.rb
+- vendor/mailup-ruby/lib/mailup/console/list.rb
+- vendor/mailup-ruby/lib/mailup/console/recipient.rb
+- vendor/mailup-ruby/lib/mailup/console/user.rb
+- vendor/mailup-ruby/lib/mailup/errors.rb
+- vendor/mailup-ruby/lib/mailup/public/base.rb
+- vendor/mailup-ruby/lib/mailup/public/console.rb
+- vendor/mailup-ruby/lib/mailup/stats/base.rb
+- vendor/mailup-ruby/lib/mailup/stats/message.rb
+- vendor/mailup-ruby/lib/mailup/stats/recipient.rb
+- vendor/mailup-ruby/lib/mailup/version.rb
+- vendor/mailup-ruby/rails/init.rb
+- vendor/omniauth-mailup/lib/omniauth-mailup.rb
+- vendor/omniauth-mailup/lib/omniauth-mailup/version.rb
+- vendor/omniauth-mailup/lib/omniauth/strategies/mailup.rb
 homepage: https://github.com/ArchimediaZerogroup/KonoMailup
 licenses:
 - MIT