acception-client 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 20ff2a379e7aefe8472423b60545e66a8554e360
+  data.tar.gz: 3732fd59dd29e75bec0a495fcc173fdc10082641
+SHA512:
+  metadata.gz: dfc67c7ce940ab2f93e03fbfc24eade5d3a40e30226c4e76ebcd146d3667bd4778a85252b8cd4895ee95e3519244718fef3423280752f6419c55a967df217b6e
+  data.tar.gz: 433f78c5870fad8b18b749da88e59aacb3a6965134576901b444813e88fa384142d706fff75e9464032edd178b1c64700f8b44c42df6b762acc3fff013b7599b

data/.gitignore

@@ -0,0 +1,22 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/.ruby-gemset

@@ -0,0 +1 @@
+acception-client

data/.ruby-version

@@ -0,0 +1 @@
+2.1.0

data/Gemfile

@@ -0,0 +1,9 @@
+source 'https://rubygems.org'
+source 'http://dev.staging.iberon.com/gemserver'
+
+# Specify your gem's dependencies in replication-subscriber.gemspec
+gemspec
+
+group :development do
+  gem 'rake-iberon', '~> 1', require: false
+end

data/LICENSE.txt

@@ -0,0 +1,3 @@
+Copyright (c) 2014 Iberon, LLC 
+
+This is proprietary software.  No license granted.

data/README.md

@@ -0,0 +1,71 @@
+# AcceptionClient
+
+An API facade for the acception service.
+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'acception_client'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install acception_client
+
+## Usage
+
+All of the API facades use the /messages endpoint.  The messages endpoint is very adaptable due to its architecture and the API facade 
+tries to abstract some of the complexities away with specific use cases that are useful.  The most adaptable facade class is the 
+OpenMessage.  The OpenMessage is the closest abstraction to the server side design.  As such, it accepts any of the aspects that are 
+available in Acception.
+
+The application parameter is only required if not proivded in the configuraiton (we strongly suggest to include this in the configuration).  
+If you do not include occurred_at in a data, message or open message, the current time is used.
+
+### Data
+
+    data   = "some-data-to-send-to-server"
+    client = Acception::Client::Data::Create.new( data, application: 'ncite',
+                                                        name: "token", 
+                                                        content_type: "text/plain" ) 
+    # defaults to MessageType::DATA
+    client.call
+
+
+### Error
+
+    client = Acception::Client::Errors::Create.new( error, application: 'ncite',       # the application can be excluded if provided in the configuraiton
+                                                           occurred_at: Time.now.utc ) 
+    # defaults to MessageType::ERROR
+    client.call
+
+In order to override the default message type for an error, just pass it as an option.
+
+    client = Acception::Client::Errors::Create.new( error, application: 'ncite', 
+                                                           message_type: Acception::MessageType::FATAL,
+                                                           occurred_at: Time.now.utc ) 
+    client.call
+
+
+### Message
+
+    client = Acception::Client::Messages::Create.new( application: 'ncite', 
+                                                      occurred_at: Time.now.utc,
+                                                      message: 'An message' )
+    # defaults to MessageType::INFO
+    client.call
+
+
+### Open Message
+
+    client = Acception::Client::OpenMessages::Create.new( message_type: Acception::MessageType::EMERGENCY, 
+                                                          application: 'ncite', 
+                                                          occurred_at: Time.now.utc,
+                                                          message: 'An open message', 
+                                                          path: 'asdf/asdf/asdf' )
+    client.call

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+

data/acception-client.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'acception/client/version'
+
+Gem::Specification.new do |spec|
+  spec.authors       = ["C. Jason Harrelson"]
+  spec.email         = ["cjharrelson@iberon.com"]
+  spec.summary       = %q{An API facade for the acception service.}
+  spec.description   = %q{An API facade for the acception service.  See README for more info.}
+  spec.homepage      = "https://gitlab.staging.iberon.com/common/acception_client"
+  spec.license       = ""
+  spec.name          = "acception-client"
+  spec.version       = Acception::Client::VERSION
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.6"
+  spec.add_development_dependency "rake"
+
+  spec.add_dependency "endow", "~> 1"
+  spec.add_dependency "enumerative"
+  spec.add_dependency "hashie"
+  spec.add_dependency "oj"
+end

data/config/locales/en.yml

@@ -0,0 +1,10 @@
+en:
+  enumerations:
+    acception/message_type:
+      data: Data
+      debug: Debug
+      emergency: Emergency
+      error: Error
+      fatal: Fatal
+      info: Info
+      warning: Warning

data/lib/acception-client.rb

@@ -0,0 +1 @@
+require 'acception/client'

data/lib/acception/client.rb

@@ -0,0 +1,29 @@
+require 'endow'
+require 'enumerative'
+require 'hashie'
+require 'time'
+require 'acception/message_type'
+require 'acception/client/version'
+
+module Acception
+  module Client
+
+    autoload :Configuration, 'acception/client/configuration'
+    autoload :Data,          'acception/client/data'
+    autoload :Endpoint,      'acception/client/endpoint'
+    autoload :Errors,        'acception/client/errors'
+    autoload :Messages,      'acception/client/messages'
+    autoload :OpenMessages,  'acception/client/open_messages'
+
+    def self.configuration
+      @configuration ||= Configuration.new
+    end
+
+    def self.configure
+      yield( configuration ) if block_given?
+    end
+
+    I18n.load_path += Dir[File.expand_path( '../../../config/locales', __FILE__ ) + '/*.{rb,yml}']
+
+  end
+end

data/lib/acception/client/configuration.rb

@@ -0,0 +1,86 @@
+require 'endow'
+
+module Acception
+  module Client
+    class Configuration
+
+      attr_accessor :application
+
+      def authentication_token
+        raise 'authentication_token configuration missing' unless @authentication_token
+        @authentication_token
+      end
+
+      def authentication_token=( authentication_token )
+        @authentication_token = authentication_token
+      end
+
+      def base_url
+        raise 'base_url configuration missing' unless @base_url
+        @base_url
+      end
+
+      def base_url=( base_url )
+        @base_url = base_url
+      end
+
+      def graceful_errors_map
+        @graceful_errors_map ||= {}
+      end
+
+      def graceful_errors_map=( map )
+        @graceful_errors_map = map
+      end
+
+      def logger
+        @logger
+      end
+
+      def logger=( logger )
+        @logger = logger
+        Endow.configure { |c| c.logger = logger }
+      end
+
+      def open_timeout_in_seconds
+        @open_timeout_in_seconds ||= 10
+      end
+
+      def open_timeout_in_seconds=( open_timeout_in_seconds )
+        @open_timeout_in_seconds = open_timeout_in_seconds
+      end
+
+      def read_timeout_in_seconds
+        @read_timeout_in_seconds ||= 10
+      end
+
+      def read_timeout_in_seconds=( read_timeout_in_seconds )
+        @read_timeout_in_seconds = read_timeout_in_seconds
+      end
+
+      def retry_sleep
+        @retry_sleep ||= false
+      end
+
+      def retry_sleep=( retry_sleep )
+        @retry_sleep = retry_sleep
+      end
+
+      def retry_attempts
+        @retry_attempts ||= 0
+      end
+
+      def retry_attempts=( retry_attempts )
+        @retry_attempts = retry_attempts
+      end
+
+      def ssl_verify_mode
+        @ssl_verify_mode ||= :none # one of [:none, :peer, :fail_if_no_peer_cert, :client_once]
+      end
+
+      def ssl_verify_mode=( ssl_verify_mode )
+        @ssl_verify_mode = ssl_verify_mode
+      end
+
+    end
+  end
+end

data/lib/acception/client/data.rb

@@ -0,0 +1,9 @@
+module Acception
+  module Client
+    module Data
+
+      autoload :Create, 'acception/client/data/create'
+
+    end
+  end
+end

data/lib/acception/client/data/create.rb

@@ -0,0 +1,48 @@
+module Acception
+  module Client
+    module Data
+      class Create < Acception::Client::Endpoint
+
+        def initialize( data, attributes={} )
+          @data       = data
+          @attributes = attributes
+        end
+
+      protected
+
+        attr_reader :data
+
+        def message_type
+          Acception::MessageType::DATA.key
+        end
+
+        def occurred_at
+          (attributes[:occurred_at] || Time.now.utc).iso8601
+        end
+
+        def variables
+          [
+            {
+              name: attributes[:name],
+              content: data,
+              content_type: attributes[:content_type]
+            }.reject { |k,v| v.blank? }
+          ]
+        end
+
+        def endpoint
+          '/messages'
+        end
+
+        def http_verb
+          :post
+        end
+
+        def success_error_codes
+          [201]
+        end
+
+      end
+    end
+  end
+end

data/lib/acception/client/endpoint.rb

@@ -0,0 +1,165 @@
+module Acception
+  module Client
+    class Endpoint
+
+      include Endow::Endpoint
+
+      def call
+        set_content( synthesized_attributes )
+        super
+      end
+
+    protected
+
+      attr_reader :attributes
+
+      def synthesized_attributes
+        {
+          application: application,
+          comment: comment,
+          environment: environment,
+          message: message,
+          message_type: message_type,
+          occurred_at: occurred_at,
+          path: path,
+          request_headers: request_headers,
+          request_parameters: request_parameters,
+          stack: stack,
+          session: session,
+          type: type,
+          variables: variables
+        }.reject { |k,v| v.blank? }
+      end
+
+      def application
+        application = attributes[:application] || Acception::Client::Configuration.application
+        raise 'application must be provided or configured for acception error reporting' unless application
+        application
+      end
+
+      def comment
+        attributes[:comment]
+      end
+
+      def clean_text_for_request( text )
+        text.gsub( /\n\ \ /, "\n" ).
+             gsub( "`", "'" ).
+             gsub( "'", "\"" )
+      end
+
+      def environment
+        attributes[:environment]
+      end
+
+      def message
+        attributes[:message]
+      end
+
+      def message_type
+        message_type = attributes[:message_type]
+        raise 'message_type is a required attribute' unless message_type
+        Acception::MessageType.new( message_type ).key
+      end
+
+      def occurred_at
+        attributes[:occurred_at].try( :iso8601 )
+      end
+
+      def path
+        attributes[:path]
+      end
+
+      def request_headers
+        attributes[:request_headers]
+      end
+
+      def request_parameters
+        attributes[:request_parameters]
+      end
+
+      def session
+        attributes[:session]
+      end
+
+      def stack
+        stack = attributes[:stack]
+        return nil unless stack
+        raise 'stack must be an Array' unless stack.is_a?( Array )
+
+        clean_text_for_request( stack.join( "\n" ))
+      end
+
+      def type
+        attributes[:type]
+      end
+
+      def variables
+        attributes[:variables]
+      end
+
+      def retryable_times
+        Acception::Client.configuration.retry_attempts
+      end
+
+      def retryable_sleep
+        Acception::Client.configuration.retry_sleep
+      end
+
+      def open_timeout_in_seconds
+        Acception::Client.configuration.open_timeout_in_seconds
+      end
+
+      def read_timeout_in_seconds
+        Acception::Client.configuration.read_timeout_in_seconds
+      end
+
+      def default_headers
+        {
+          'Accept'                 => accept,
+          'Content-Type'           => content_type,
+          authentication_token_key => authentication_token
+        }.reject { |k,v| v.blank? }
+      end
+
+      def accept
+        'application/vnd.acception-v1+json'
+      end
+
+      def determine_accept_name
+        matches = accept.match( /(.*)\/vnd\.(.*)-(v\d+)\+(.*)/ )
+        [matches[1],
+         matches[4]].join( '_' )
+      end
+
+      def content_type
+        'application/json'
+      end
+
+      def response_wrapper_class
+        Hashie::Mash
+      end
+
+      def authentication_token_key
+        'Auth-Token'
+      end
+
+      def authentication_token
+        Acception::Client.configuration.authentication_token
+      end
+
+      def base_url
+        File.join( Acception::Client.configuration.base_url ,
+                   'api' )
+      end
+
+      def ssl_verify_mode
+        Acception::Client.configuration.ssl_verify_mode
+      end
+
+      def graceful_errors_map
+        Acception::Client.configuration.graceful_errors_map
+      end
+
+    end
+  end
+end

data/lib/acception/client/errors.rb

@@ -0,0 +1,9 @@
+module Acception
+  module Client
+    module Errors
+
+      autoload :Create, 'acception/client/errors/create'
+
+    end
+  end
+end

data/lib/acception/client/errors/create.rb

@@ -0,0 +1,49 @@
+module Acception
+  module Client
+    module Errors
+      class Create < Acception::Client::Endpoint
+
+        def initialize( error, attributes={} )
+          @error      = error
+          @attributes = attributes
+        end
+
+      protected
+
+        attr_reader :error
+
+        def message
+          error.try :message
+        end
+
+        def message_type
+          Acception::MessageType.new( attributes[:message_type] || Acception::MessageType::ERROR ).key
+        end
+
+        def stack
+          stack = error.try( :backtrace )
+          return nil unless stack
+
+          clean_text_for_request( stack.join( "\n" ))
+        end
+
+        def type
+          error.try( :class ).try( :name )
+        end
+
+        def endpoint
+          '/messages'
+        end
+
+        def http_verb
+          :post
+        end
+
+        def success_error_codes
+          [201]
+        end
+
+      end
+    end
+  end
+end

data/lib/acception/client/messages.rb

@@ -0,0 +1,9 @@
+module Acception
+  module Client
+    module Messages
+
+      autoload :Create, 'acception/client/messages/create'
+
+    end
+  end
+end

data/lib/acception/client/messages/create.rb

@@ -0,0 +1,38 @@
+module Acception
+  module Client
+    module Messages
+      class Create < Acception::Client::Endpoint
+
+        def initialize( message, attributes={} )
+          @message    = message
+          @attributes = attributes
+        end
+
+      protected
+
+        attr_reader :message
+
+        def message_type
+          Acception::MessageType.new( attributes[:message_type] || Acception::MessageType::INFO ).key
+        end
+
+        def occurred_at
+          (attributes[:occurred_at] || Time.now.utc).iso8601
+        end
+
+        def endpoint
+          '/messages'
+        end
+
+        def http_verb
+          :post
+        end
+
+        def success_error_codes
+          [201]
+        end
+
+      end
+    end
+  end
+end

data/lib/acception/client/open_messages.rb

@@ -0,0 +1,9 @@
+module Acception
+  module Client
+    module OpenMessages
+
+      autoload :Create, 'acception/client/open_messages/create'
+
+    end
+  end
+end

data/lib/acception/client/open_messages/create.rb

@@ -0,0 +1,31 @@
+module Acception
+  module Client
+    module OpenMessages
+      class Create < Acception::Client::Endpoint
+
+        def initialize( attributes )
+          @attributes = attributes
+        end
+
+      protected
+
+        def occurred_at
+          (attributes[:occurred_at] || Time.now.utc).iso8601
+        end
+
+        def endpoint
+          '/messages'
+        end
+
+        def http_verb
+          :post
+        end
+
+        def success_error_codes
+          [201]
+        end
+
+      end
+    end
+  end
+end

data/lib/acception/client/version.rb

@@ -0,0 +1,7 @@
+module Acception
+  module Client
+
+    VERSION = "1.0.0"
+
+  end
+end

data/lib/acception/message_type.rb

@@ -0,0 +1,27 @@
+module Acception
+  class MessageType
+
+    def self.valid_keys
+      %w(
+        data
+        debug
+        emergency
+        error
+        fatal
+        info
+        warning
+      )
+    end
+
+    include Enumerative::Enumeration
+
+    # DATA
+    # DEBUG
+    # EMERGENCY
+    # ERROR
+    # FATAL
+    # INFO
+    # WARNING
+
+  end
+end

metadata

@@ -0,0 +1,151 @@
+--- !ruby/object:Gem::Specification
+name: acception-client
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- C. Jason Harrelson
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-06-22 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: endow
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1'
+- !ruby/object:Gem::Dependency
+  name: enumerative
+  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: hashie
+  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: oj
+  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'
+description: An API facade for the acception service.  See README for more info.
+email:
+- cjharrelson@iberon.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".ruby-gemset"
+- ".ruby-version"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- acception-client.gemspec
+- config/locales/en.yml
+- lib/acception-client.rb
+- lib/acception/client.rb
+- lib/acception/client/configuration.rb
+- lib/acception/client/data.rb
+- lib/acception/client/data/create.rb
+- lib/acception/client/endpoint.rb
+- lib/acception/client/errors.rb
+- lib/acception/client/errors/create.rb
+- lib/acception/client/messages.rb
+- lib/acception/client/messages/create.rb
+- lib/acception/client/open_messages.rb
+- lib/acception/client/open_messages/create.rb
+- lib/acception/client/version.rb
+- lib/acception/message_type.rb
+homepage: https://gitlab.staging.iberon.com/common/acception_client
+licenses:
+- ''
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.1
+signing_key: 
+specification_version: 4
+summary: An API facade for the acception service.
+test_files: []