unique_response_ruby 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 4f11e3916f4c04ba3fd47d4626f5e6931f16ce59
+  data.tar.gz: 68dd7ac19824d995a3912eabdf3516110dd82556
+SHA512:
+  metadata.gz: c65eff1e9b39d4141938d9a41f128f50f9302ac72723929e6bb83509ba5925430204e7a29edc1efcc76b0f217fee811febdd441522656dc3d44bf210065079b9
+  data.tar.gz: 37a47c1dcfba4dad7efb7e1472a5e962fb764b5a5c3d4852fbe69168985677c912507f4f8dc9c595c3b0e026be0ddca359af26a3fb1c2d022f38427dd9201848

data/.gitignore

@@ -0,0 +1,15 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status
+
+# environment variables
+.env

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.ruby-version

@@ -0,0 +1 @@
+2.4.1

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.3.2
+before_install: gem install bundler -v 1.14.6

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in unique_response_ruby.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 John Alston
+
+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,73 @@
+# UniqueResponseRuby
+
+Official Ruby SDK for Bovitz Unique Response.
+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'unique_response_ruby'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install unique_response_ruby
+
+
+## Setup
+
+Set the following environment variables
+
+UNIQUE_RESPONSE_ACCOUNT_ID
+UNIQUE_RESPONSE_AUTH_TOKEN
+UNIQUE_RESPONSE_ENDPOINT
+
+
+## Usage
+
+
+```ruby
+# Initialize a new survey response with the needed attribute values as all strings.  All values are required.
+response = UniqueResponse::Response.new("panelist123", "respondent123", "63.116.49.146", "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_12_3) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/56.0.2924.87 Safari/537.36", "survey123")
+
+# Use the "save" method to post it to the API
+response.save 
+# => true
+
+# If the "save" method was successful, use "matches" to return an array of matching responses that share the same ip_address and survey_token.  If no matches are found, an empty array is returned.
+response.matches
+# => [{"created_at"=>1491424044817, "survey_token"=>"survey123", "ip_address"=>"63.116.49.146", "respondent_id"=>"respondent234", "user_agent"=>"Mozilla/5.0 (Macintosh; Intel Mac OS X 10_12_3) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/56.0.2924.87 Safari/537.36", "panelist_id"=>"panelist234", "id"=>"47834810-1a3e-11e7-96bd-e56461835d2d"}, {"created_at"=>1491424066668, "survey_token"=>"survey123", "ip_address"=>"63.116.49.146", "respondent_id"=>"respondent345", "user_agent"=>"Mozilla/5.0 (Macintosh; Intel Mac OS X 10_12_3) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/56.0.2924.87 Safari/537.37", "panelist_id"=>"panelist345", "id"=>"54897ac0-1a3e-11e7-96bd-e56461835d2d"}]
+
+
+# Use these convenient methods to detect duplications
+response.duplicate_ip_address?
+# => true
+
+response.duplicate_user_agent?
+# => true
+
+response.duplicate_ip_and_ua?
+# => true
+```
+
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/johnalston/unique_response_ruby.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,16 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "unique_response_ruby"
+require "dotenv"
+Dotenv.load!
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/unique_response_ruby.rb

@@ -0,0 +1,7 @@
+require "unique_response_ruby/version"
+require "unique_response_ruby/client"
+require "unique_response_ruby/response"
+
+module UniqueResponse
+  # Your code goes here...
+end

data/lib/unique_response_ruby/client.rb

@@ -0,0 +1,54 @@
+module UniqueResponse
+  require 'net/http'
+  require 'net/https'
+  require 'json'
+
+  class Client
+    attr_reader :successful, :data
+
+    HTTP_HEADERS = {
+        'Content-Type' => 'application/json',
+        'Accept' => 'application/json',
+        'Accept-Charset' => 'utf-8',
+        'User-Agent' => 'unique_response_ruby'
+    }
+
+    def initialize
+      @account_id = ENV['UNIQUE_RESPONSE_ACCOUNT_ID']
+      @auth_token = ENV['UNIQUE_RESPONSE_AUTH_TOKEN']
+      if @account_id.nil? || @auth_token.nil?
+        raise ArgumentError, 'Account SID and auth token are required'
+      end
+    end
+
+    def save_response(response)
+      @uri = URI(ENV['UNIQUE_RESPONSE_ENDPOINT'])
+      @http_request = Net::HTTP::Post.new @uri.path, HTTP_HEADERS
+      @http_request.body = response.to_h.to_json
+      perform_request
+    end
+
+    private
+      def perform_request
+        http_response = Net::HTTP.start(@uri.host, @uri.port, use_ssl: true) do |http|
+          http.request @http_request
+        end
+
+        case http_response
+        when Net::HTTPSuccess, Net::HTTPRedirection
+          body = JSON.parse http_response.body
+          if @successful = body["successful"] || false
+            @data = body["data"]
+          else
+            @data = "Error saving response: #{body["data"].to_json}"
+          end
+        else
+          @data = "#{http_response.code}: #{http_response.body}"
+          @successful = false
+        end
+
+        return @successful
+      end
+
+  end
+end

data/lib/unique_response_ruby/response.rb

@@ -0,0 +1,35 @@
+module UniqueResponse
+
+  Response = Struct.new(:panelist_id, :respondent_id, :ip_address, :user_agent, :survey_token) do
+    attr_reader :matches
+
+    def valid?
+      values.map { |value| value.is_a?(String) && !value.empty? }.reduce(:&)
+    end
+
+    def save
+      raise ArgumentError unless valid?
+
+      client = Client.new
+      if client.save_response(self)
+        @matches = client.data
+        true
+      else
+        false
+      end
+    end
+
+    def duplicate_ip_address?
+      @matches.any? { |match| match["ip_address"] == ip_address }
+    end
+
+    def duplicate_user_agent?
+      @matches.any? { |match| match["user_agent"] == user_agent }
+    end
+
+    def duplicate_ip_and_ua?
+      @matches.any? { |match| match["ip_address"] == ip_address && match["user_agent"] == user_agent }
+    end
+  end
+
+end

data/lib/unique_response_ruby/version.rb

@@ -0,0 +1,3 @@
+module UniqueResponseRuby
+  VERSION = "0.1.0"
+end

data/unique_response_ruby.gemspec

@@ -0,0 +1,36 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'unique_response_ruby/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "unique_response_ruby"
+  spec.version       = UniqueResponseRuby::VERSION
+  spec.authors       = ["John Alston"]
+  spec.email         = ["jalston@bovitzinc.com"]
+
+  spec.summary       = %q{Ruby SDK for Unique Response}
+  spec.description   = %q{Ruby SDK for Unique Response}
+  spec.homepage      = "http://www.bovitzinc.com"
+  spec.license       = "MIT"
+
+  if spec.respond_to?(:metadata)
+    spec.metadata['allowed_push_host'] = "https://rubygems.org"
+  else
+    raise "RubyGems 2.0 or newer is required to protect against " \
+      "public gem pushes."
+  end
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.14"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "webmock"
+  spec.add_development_dependency "dotenv"
+end

metadata

@@ -0,0 +1,130 @@
+--- !ruby/object:Gem::Specification
+name: unique_response_ruby
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- John Alston
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-04-10 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  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: dotenv
+  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 SDK for Unique Response
+email:
+- jalston@bovitzinc.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".ruby-version"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/unique_response_ruby.rb
+- lib/unique_response_ruby/client.rb
+- lib/unique_response_ruby/response.rb
+- lib/unique_response_ruby/version.rb
+- unique_response_ruby.gemspec
+homepage: http://www.bovitzinc.com
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+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.6.11
+signing_key: 
+specification_version: 4
+summary: Ruby SDK for Unique Response
+test_files: []