zenps-ruby 0.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 5e271f0e89ea5c2b50ee41b4b32341089ad9c806adcf65083de65fe04e01fa72
+  data.tar.gz: 0a5adda8c8afecc4f5f24ef3eb9f29623c9f749ebcb6db2ddfa6694bd2b05337
+SHA512:
+  metadata.gz: f23b98117c2e18c3a8944dca873571a7b91a0eed744814c2ac6d11ab33d1e8c0d9e4a543b9fc89f206448f788f4435bc1dfac4dd0aa10ac27ec36f262db6d34d
+  data.tar.gz: ae19e9a9a630523b87eb3a0195ae5c4ffe70ff2ce43b2d6a0d799fb6b1a629531ed2bd5278bd39a798ec22308d3c3e74b034328aadc8133d5d18a65b011a59bd

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2019 Alexis Philippart de Foy
+
+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,96 @@
+[![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)
+
+# zenps-ruby
+
+Wrapper for Zenps API
+
+## Installation
+```sh
+gem install zenps-ruby
+```
+
+Or with bundler
+
+```ruby
+gem 'zenps-ruby'
+```
+
+
+## Configuration
+
+This library needs to be configured with a Zenps Api key. Configuration can be performed as follows using a hash
+
+```ruby
+Zenps.configure(zenps_key: 'YOUR_ZENPS_KEY')
+```
+
+or with a yml configuration file
+
+```ruby
+Zenps.configure_with('path/to/your/configuration/file.yml')
+```
+
+## Usage
+
+This wrapper allows you to send NPS surveys to your user in batch...
+
+```ruby
+Zenps::Survey.call([user_1, user_2])
+```
+
+...or on a per-user basis
+
+```ruby
+Zenps::Survey.call(user)
+```
+
+A user subject can either be:
+
+  - A string (email of user to be surveyed)
+  - A hash containing the following keys:
+    - email (compulsory)
+    - locale (optional --> defaults to `en`)
+  - An object that responds to
+    - email method (compulsory)
+    - locale (optional --> defaults to `en`)
+
+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))
+```
+
+but also in a more simple way as follows
+
+```ruby
+Zenps::Survey.call('john.doe@acme.com')
+```
+
+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
+
+Example:
+
+```ruby
+Zenps::Survey.call(user, locale: 'fr', event: 'sign_up', tags: ['man', 'facebook'])
+```
+
+
+## Contributing to pipedrive-ruby
+
+* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet.
+* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it.
+* Fork the project.
+* Start a feature/bugfix branch.
+* Commit and push until you are happy with your contribution.
+* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
+* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
+
+## License
+
+This gem is released under the [MIT License](http://www.opensource.org/licenses/MIT).

data/README.rdoc

@@ -0,0 +1,18 @@
+= zenps-ruby
+
+Ruby wrapper for the Zenps API
+
+== Contributing to zenps-ruby
+
+* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet.
+* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it.
+* Fork the project.
+* Start a feature/bugfix branch.
+* Commit and push until you are happy with your contribution.
+* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
+* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
+
+== Copyright
+
+Copyright (c) 2019 Alexis Philippart de Foy. See LICENSE.txt for
+further details.

data/lib/zenps-ruby.rb

@@ -0,0 +1,47 @@
+
+require 'yaml'
+require 'logger'
+require 'zenps/client.rb'
+require 'zenps/payload.rb'
+require 'zenps/survey.rb'
+module Zenps
+  # Configuration defaults
+  @config = {
+    zenps_key: nil
+  }
+
+  @valid_config_keys = @config.keys
+
+  @logger = Logger.new(STDOUT)
+
+  # Configure through hash
+  def self.configure(options = {})
+    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))
+    rescue Errno::ENOENT
+      raise ConfigurationPathError
+    end
+    configure(config)
+  end
+
+  def self.config
+    @config
+  end
+
+  class KeyMissingError < StandardError
+    def initialize(msg="Zenps configuration key missing")
+      super
+    end
+  end
+
+  class ConfigurationPathError < StandardError
+    def initialize(msg="YAML configuration file couldn't be found.")
+      super
+    end
+  end
+end

data/lib/zenps/client.rb

@@ -0,0 +1,83 @@
+require 'net/http'
+require 'uri'
+require 'json'
+
+module Zenps
+  class Client
+
+    def initialize
+      check_configuration
+    end
+
+    def call(options={})
+      @options = options
+      perform_request
+      expose_response
+    end
+
+    private
+
+    attr_reader :options, :response
+
+    def check_configuration
+      raise KeyMissingError if ::Zenps.config[:zenps_key].nil?
+    end
+
+    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}
+    end
+
+    def expose_response
+      {
+        email: email,
+        code: response.code.to_i,
+        body: response.body
+      }
+    end
+
+    def body
+      {
+        to: {
+          email: email,
+        },
+        locale: locale,
+        event: event,
+        tags: tags
+      }.compact.to_json
+    end
+
+    def uri
+      @uri ||= URI.parse(end_point)
+    end
+
+    def header
+      @header ||= {
+        'Content-Type': 'text/json',
+        'Authorization': ::Zenps.config[:zenps_key]
+      }
+    end
+
+    def email
+      options[:email]
+    end
+
+    def locale
+      options['locale'] || options[:locale] || 'en'
+    end
+
+    def event
+      options['event'] || options[:event]
+    end
+
+    def tags
+      (options['tags'] || options[:tags] || []).join(', ')
+    rescue NoMethodError
+    end
+
+    def end_point
+      'https://api.zenps.io/nps/v1/surveys'
+    end
+  end
+end

data/lib/zenps/payload.rb

@@ -0,0 +1,46 @@
+module Zenps
+  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
+    end
+
+    private
+
+    attr_reader :subjects
+
+    def payload
+      @subjects = [subjects] unless array_but_not_hash?
+      return get_payload
+    end
+
+    def get_payload
+      return subjects.map do |subject|
+        {
+          email: get_email(subject),
+          locale: get_locale(subject)
+        }.compact
+      end
+    end
+
+    def get_email(object)
+      return object if object.class == String
+      return object[:email] || object['email'] if object.class == Hash
+      return object.email if object.respond_to? :email
+    end
+
+    def get_locale(object)
+      return if object.class == String
+      return object[:locale] || object['locale'] if object.class == Hash
+      return object.locale if object.respond_to? :locale
+    end
+
+    def array_but_not_hash?
+      subjects.respond_to?(:each) && !subjects.respond_to?(:keys)
+    end
+  end
+end

data/lib/zenps/survey.rb

@@ -0,0 +1,32 @@
+module Zenps
+  class Survey
+    # Takes list of subjects and sends NPS survey to all subjects
+    def self.call(subjects, options={})
+      new.call(subjects, options)
+    end
+
+    def call(subjects, options={})
+      @subjects = subjects
+      @options = options
+      perform_requests
+    end
+
+    private
+
+    attr_reader :subjects, :options
+
+    def perform_requests
+      payload_getter.get(subjects).map do |payload|
+        api_client.call(payload.merge(options))
+      end
+    end
+
+    def payload_getter
+      @payload_getter ||= Payload.new
+    end
+
+    def api_client
+      @api_client ||= Client.new
+    end
+  end
+end

metadata

@@ -0,0 +1,150 @@
+--- !ruby/object:Gem::Specification
+name: zenps-ruby
+version: !ruby/object:Gem::Version
+  version: 0.0.0
+platform: ruby
+authors:
+- Alexis Philippart de Foy
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-03-08 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.5.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.5.0
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.5.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.5.1
+- !ruby/object:Gem::Dependency
+  name: rdoc
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.12'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: juwelier
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.1.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.1.0
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  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: simplecov-console
+  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: []
+extensions: []
+extra_rdoc_files:
+- LICENSE.txt
+- README.md
+- README.rdoc
+files:
+- LICENSE.txt
+- README.md
+- README.rdoc
+- lib/zenps-ruby.rb
+- lib/zenps/client.rb
+- lib/zenps/payload.rb
+- lib/zenps/survey.rb
+homepage: http://github.com/aphilippartd/zenps-ruby
+licenses:
+- MIT
+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: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: Ruby wrapper for Zenps
+test_files: []