zenps-ruby 0.0.0 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5e271f0e89ea5c2b50ee41b4b32341089ad9c806adcf65083de65fe04e01fa72
-  data.tar.gz: 0a5adda8c8afecc4f5f24ef3eb9f29623c9f749ebcb6db2ddfa6694bd2b05337
+  metadata.gz: 931e2368e823cda7839fa93c039c78c1c8100abe3946b43ef5823e87b8145e32
+  data.tar.gz: c316c9c3acaabda72b797ecd47bc5017f6491e64055ff1b51f720606c64c5c28
 SHA512:
-  metadata.gz: f23b98117c2e18c3a8944dca873571a7b91a0eed744814c2ac6d11ab33d1e8c0d9e4a543b9fc89f206448f788f4435bc1dfac4dd0aa10ac27ec36f262db6d34d
-  data.tar.gz: ae19e9a9a630523b87eb3a0195ae5c4ffe70ff2ce43b2d6a0d799fb6b1a629531ed2bd5278bd39a798ec22308d3c3e74b034328aadc8133d5d18a65b011a59bd
+  metadata.gz: 32cab1857eecb8c81e3fce35cf1d9ff2fe07e394441987f8df03a2be7032c3137d7e8a8fad7f6f0b21197ecbfd95fcc40e6bea12c84151d3647a7fcb90d99d9c
+  data.tar.gz: ecfbe289ddf70293b10bb8a1d50647da99e0d24f91ead8bffd783bf80ed656804b8d53a623bd2b38eff446094f2cb8339cdcfc227404a878d60f02557944e885

data/README.md

@@ -1,3 +1,4 @@
+[![Gem Version](https://badge.fury.io/rb/zenps-ruby.svg)](https://badge.fury.io/rb/zenps-ruby)
 [![Codeship Status for aphilippartd/zenps-ruby](https://app.codeship.com/projects/beb50360-2413-0137-0f16-0e0a32caa97a/status?branch=master)](https://app.codeship.com/projects/330078)
 [![Maintainability](https://api.codeclimate.com/v1/badges/065b707a3ccd884c40d6/maintainability)](https://codeclimate.com/github/aphilippartd/zenps-ruby/maintainability)
 [![Test Coverage](https://api.codeclimate.com/v1/badges/065b707a3ccd884c40d6/test_coverage)](https://codeclimate.com/github/aphilippartd/zenps-ruby/test_coverage)
@@ -37,13 +38,13 @@ Zenps.configure_with('path/to/your/configuration/file.yml')
 This wrapper allows you to send NPS surveys to your user in batch...
 
 ```ruby
-Zenps::Survey.call([user_1, user_2])
+Zenps::Survey.call([user_1, user_2], event: 'sign_up')
 ```
 
 ...or on a per-user basis
 
 ```ruby
-Zenps::Survey.call(user)
+Zenps::Survey.call(user, event: 'sign_up')
 ```
 
 A user subject can either be:
@@ -59,20 +60,22 @@ A user subject can either be:
 This allows for the gem to be used eg. in a rails application with User models that respond to the email method (and/or locale) as follows
 
 ```ruby
-  Zenps::Survey.call(User.limit(10))
+  Zenps::Survey.call(User.limit(10), event: 'sign_up')
 ```
 
 but also in a more simple way as follows
 
 ```ruby
-Zenps::Survey.call('john.doe@acme.com')
+Zenps::Survey.call('john.doe@acme.com', event: 'sign_up')
 ```
 
 The following options are available on the Survey call method:
 
-  - locale (String) - Overwrites the user's AND default locale
-  - event (String) - Typically the event triggering the NPS survey
-  - tags (Array) - Tags giving you granularity in your analytics
+| Options | Type            | Mandatory | Description                                     |
+| --------|:---------------:| :--------:|------------------------------------------------:|
+| locale  | String          | false     | Overwrites the user's AND default locale        |
+| event   | String          | true      | Typically the event triggering the NPS survey   |
+| tags    | Array\[String\] | false     | Tags giving you granularity in your analytics   |
 
 Example:
 

data/lib/zenps-ruby.rb

@@ -1,9 +1,9 @@
-
 require 'yaml'
 require 'logger'
-require 'zenps/client.rb'
-require 'zenps/payload.rb'
-require 'zenps/survey.rb'
+require_relative 'zenps/client.rb'
+require_relative 'zenps/payload.rb'
+require_relative 'zenps/survey.rb'
+# Zenps ruby wrapper
 module Zenps
   # Configuration defaults
   @config = {
@@ -16,13 +16,13 @@ module Zenps
 
   # Configure through hash
   def self.configure(options = {})
-    options.each {|k,v| @config[k.to_sym] = v if @valid_config_keys.include? k.to_sym}
+    options.each { |k, v| @config[k.to_sym] = v if @valid_config_keys.include? k.to_sym }
   end
 
   # Configure through yaml file
   def self.configure_with(path_to_yaml_file)
     begin
-      config = YAML::load(IO.read(path_to_yaml_file))
+      config = YAML.safe_load(IO.read(path_to_yaml_file))
     rescue Errno::ENOENT
       raise ConfigurationPathError
     end
@@ -33,14 +33,16 @@ module Zenps
     @config
   end
 
+  # Missing ZENPS key error
   class KeyMissingError < StandardError
-    def initialize(msg="Zenps configuration key missing")
+    def initialize(msg = 'Zenps configuration key missing')
       super
     end
   end
 
+  # Wrong configuration path error
   class ConfigurationPathError < StandardError
-    def initialize(msg="YAML configuration file couldn't be found.")
+    def initialize(msg = "YAML configuration file couldn't be found.")
       super
     end
   end

data/lib/zenps/client.rb

@@ -3,13 +3,13 @@ require 'uri'
 require 'json'
 
 module Zenps
+  # Api client for Zenps
   class Client
-
     def initialize
       check_configuration
     end
 
-    def call(options={})
+    def call(options = {})
       @options = options
       perform_request
       expose_response
@@ -26,7 +26,7 @@ module Zenps
     def perform_request
       request = Net::HTTP::Post.new(uri, header)
       request.body = body
-      @response = Net::HTTP.start(uri.host, uri.port, :use_ssl => true) {|http| http.request request}
+      @response = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |http| http.request request }
     end
 
     def expose_response
@@ -40,7 +40,7 @@ module Zenps
     def body
       {
         to: {
-          email: email,
+          email: email
         },
         locale: locale,
         event: event,
@@ -74,6 +74,7 @@ module Zenps
     def tags
       (options['tags'] || options[:tags] || []).join(', ')
     rescue NoMethodError
+      nil
     end
 
     def end_point

data/lib/zenps/payload.rb

@@ -1,12 +1,12 @@
 module Zenps
+  # Class for structuring subjects into array of hashes from:
+  #   - (array of) string(s)
+  #   - (array of) hash(es)
+  #   - (array of) object(s)
   class Payload
-    # Returns array of hashes from:
-    #   - (array of) string(s)
-    #   - (array of) hash(es)
-    #   - (array of) object(s)
     def get(subjects)
       @subjects = subjects
-      return payload
+      payload
     end
 
     private
@@ -15,11 +15,11 @@ module Zenps
 
     def payload
       @subjects = [subjects] unless array_but_not_hash?
-      return get_payload
+      build_payload
     end
 
-    def get_payload
-      return subjects.map do |subject|
+    def build_payload
+      subjects.map do |subject|
         {
           email: get_email(subject),
           locale: get_locale(subject)

data/lib/zenps/survey.rb

@@ -1,11 +1,11 @@
 module Zenps
+  # Takes list of subjects and sends NPS survey to all subjects
   class Survey
-    # Takes list of subjects and sends NPS survey to all subjects
-    def self.call(subjects, options={})
+    def self.call(subjects, options = {})
       new.call(subjects, options)
     end
 
-    def call(subjects, options={})
+    def call(subjects, options = {})
       @subjects = subjects
       @options = options
       perform_requests

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: zenps-ruby
 version: !ruby/object:Gem::Version
-  version: 0.0.0
+  version: 0.0.2
 platform: ruby
 authors:
 - Alexis Philippart de Foy
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-03-08 00:00:00.000000000 Z
+date: 2019-03-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -108,6 +108,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  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'
 description: Ruby wrapper for Zenps
 email: alexis.philippartdefoy@gmail.com
 executables: []