thisdata 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 1bd194d89f48c0774d981d4c093ef12a1ed1b16e
+  data.tar.gz: 39ea8f55aaa501587e46cdb586e41a29f711760c
+SHA512:
+  metadata.gz: 0f9c4c7388e0b80d34e78f798fc5691b4db3f864e7ca84db4ddd11499b1395cd76eb33ea3fcc4ff2a4faaa2e48ac428e877e99fabe63a3d2aa84fb53329488ec
+  data.tar.gz: fe572684f6b1790d900ee21fe12ba508c19b017196c621b7de68b1dc99ed1cb3bf7f3e4d9106ee8eddb9cc33ca2346bad2f9688b9b992a4b9f69de4872f4807b

data/.gitignore

@@ -0,0 +1,5 @@
+/.bundle/
+/Gemfile.lock
+/tmp/
+.DS_Store
+*.gem

data/CHANGELOG

@@ -0,0 +1,3 @@
+# 0.1.0
+
+Initial release.

data/Gemfile

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

data/LICENSE.md

@@ -0,0 +1,22 @@
+Copyright (c) 2016 ThisData Ltd.
+
+MIT License
+
+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,80 @@
+# ThisData Ruby
+
+This gem allows you to use the ThisData Login Intelligence API.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'thisdata'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install thisdata
+
+## Usage
+
+Run:
+
+    rails g this_data:install YOUR_API_KEY_HERE
+
+You can find your API key by going to [ThisData](https://thisdata.com) >
+  Integrations > Login Intelligence API.
+
+The generator will create a file in `config/initializers` called "this_data.rb".
+If you need to do any further configuration or customization of ThisData,
+that's the place to do it!
+
+## Ruby
+
+You can track any event by calling `ThisData.track` and passing a Hash which
+contains an event. See examples and required fields on our API documentation:
+http://help.thisdata.com/docs/apiv1events
+
+## Rails
+
+The ThisData::TrackRequest module can be included in a ActionController, giving
+you a handy way to track requests.
+
+e.g. in `app/controllers/application_controller.rb`
+```
+class ApplicationController < ActionController::Base
+  include ThisData::TrackRequest
+
+  ...
+end
+```
+
+and in your sessions controller:
+```
+class SessionsController < ApplicationController
+
+  def finalize
+    if login_was_valid?
+      # do login stuff
+      thisdata_track
+    else
+      thisdata_track('login-denied')
+    end
+  end
+
+end
+```
+
+
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` 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/revertio/thisdata-ruby.

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList['test/**/*_test.rb']
+end
+
+task :default => :test

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "this_data"
+
+# 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

data/bin/setup

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

data/lib/generators/this_data/install_generator.rb

@@ -0,0 +1,30 @@
+module ThisData
+  class InstallGenerator < Rails::Generators::Base
+
+    argument :api_key
+
+    desc "This generator creates a configuration file for the ThisData ruby client inside config/initializers"
+    def create_configuration_file
+      initializer "this_data.rb" do
+        <<-EOS
+ThisData.setup do |config|
+  config.api_key = "#{api_key}"
+
+  # user_method will be called on a controller when using TrackRequest
+  # config.user_method =        :current_user
+
+  # The following methods will be called on the object returned by user_method,
+  # to capture details about the user
+  # config.user_id_method =     :id
+  # config.user_name_method =   :name
+  # config.user_email_method =  :email
+  # config.user_mobile_method = :mobile
+
+  # Define a Logger instance if you want to debug / track errors
+  # config.logger = Rails.logger unless Rails.env.production?
+end
+EOS
+      end
+    end
+  end
+end

data/lib/this_data.rb

@@ -0,0 +1,71 @@
+require "httparty"
+require "logger"
+require "json"
+
+require "this_data/version"
+require "this_data/verbs"
+require "this_data/client"
+require "this_data/configuration"
+require "this_data/track_request"
+
+module ThisData
+
+  class << self
+
+    # Configuration Object (instance of ThisData::Configuration)
+    attr_writer :configuration
+
+    def setup
+      yield(configuration)
+    end
+
+    def configuration
+      @configuration ||= ThisData::Configuration.new
+    end
+
+    def default_configuration
+      configuration.defaults
+    end
+
+    # Creates a Client and tracks an event.
+    # Event must be a Hash
+    def track(event)
+      Client.new.track(event)
+      log("Tracked event!")
+    rescue => e
+      ThisData.error("Failed to track event:")
+      ThisData.error(e)
+      e.backtrace.each do |line|
+        ThisData.error(line, prefix: false)
+      end
+      false
+    end
+
+    # A helper method to track a log-in event. Validates that the minimum
+    # required data is present.
+    def track_login(ip: '', user: {}, user_agent: nil)
+      raise ArgumentError, "IP Address is required" unless ip.length
+      raise ArgumentError, "User needs ID value" unless user[:id].to_s.length
+      track({
+        verb: ThisData::Verbs::LOG_IN,
+        ip: ip,
+        user_agent: user_agent,
+        user: user
+      })
+    end
+
+    def log(message, level: 'info', prefix: true)
+      if prefix
+        message = "[ThisData] " + message.to_s
+      end
+      configuration.logger.send(level, message) if configuration.logger
+    end
+    def warn(message, prefix: true)
+      log(message, level: 'warn', prefix: prefix)
+    end
+    def error(message, prefix: true)
+      log(message, level: 'error', prefix: prefix)
+    end
+
+  end
+end

data/lib/this_data/client.rb

@@ -0,0 +1,59 @@
+module ThisData
+  # For the ThisData REST APIv1
+  # http://help.thisdata.com/docs/apiv1events
+  class Client
+
+    USER_AGENT = "ThisData Ruby v#{ThisData::VERSION}"
+    NO_API_KEY_MESSAGE  = "Oops: you've got no ThisData API Key configured, so we can't send events. Specify your ThisData API key using ThisData#setup (find yours at https://thisdata.com)"
+
+    include HTTParty
+
+    base_uri "https://api.thisdata.com/v1/"
+
+    def initialize
+      @api_key = require_api_key
+      @headers = {
+        "User-Agent" => USER_AGENT
+      }
+    end
+
+    def require_api_key
+      ThisData.configuration.api_key || print_api_key_warning
+    end
+
+    # Tracks a user initiated event which has occurred within your app, e.g.
+    # a user logging in.
+    # See http://help.thisdata.com/v1.0/docs/apiv1events for more information.
+    # - event       (Required: Hash) the event, containing the following keys:
+    #  - verb       (Required: String) 'what' the user did, e.g. 'log-in'.
+    #                 See ThisData::Verbs for predefined options.
+    #  - ip         (Required: String) the IP address of the request
+    #  - user_agent (Optional: String) the user agent from the request
+    #  - user       (Required: Hash)
+    #   - id        (Required: String)  a unique identifier for this User
+    #   - email     (Optional*: String) the user's email address.
+    #   - mobile    (Optional*: String) a mobile phone number in E.164 format
+    #                 *email and/or mobile MUST be passed if you want ThisData
+    #                 to send 'Was This You?' notifications via email and/or SMS
+    #   - name      (Optional: String)  the user's name, used in notifications
+    def track(event)
+      post_event(event)
+    end
+
+    private
+
+      def version
+        ThisData.configuration.version
+      end
+
+      def post_event(payload_hash)
+        path_with_key = "/events?api_key=#{ThisData.configuration.api_key}"
+        self.class.post(path_with_key, headers: @headers, body: JSON.generate(payload_hash))
+      end
+
+      def print_api_key_warning
+        $stderr.puts(NO_API_KEY_MESSAGE)
+      end
+
+  end
+end

data/lib/this_data/configuration.rb

@@ -0,0 +1,75 @@
+require "ostruct"
+
+module ThisData
+  class Configuration
+
+    # Programatically create attr accessors for config_option
+    def self.config_option(name)
+      define_method(name) do
+        read_value(name)
+      end
+
+      define_method("#{name}=") do |value|
+        set_value(name, value)
+      end
+    end
+
+    # Your ThisData API Key - this can be found on ThisData.com > Integrations
+    #   > Login Intelligence API
+    config_option :api_key
+
+    # Log the events sent
+    config_option :logger
+
+    # TrackRequest config options
+    # We will attempt to call this method on a Controller to get the user record
+    # Default: :current_user
+    config_option :user_method
+    # This method should return a unique ID for a user. Default: :id
+    config_option :user_id_method
+    # This method should return the user's name. Default: :name
+    config_option :user_name_method
+    # This method should return the user's email. Default: :email
+    config_option :user_email_method
+    # This method should return the user's mobile phone number. Default: :mobile
+    config_option :user_mobile_method
+
+    attr_reader :defaults
+
+    def initialize
+      @config_values = {}
+
+      # set default attribute values
+      @defaults = OpenStruct.new({
+        user_method:        :current_user,
+        user_id_method:     :id,
+        user_name_method:   :name,
+        user_email_method:  :email,
+        user_mobile_method: :mobile
+      })
+    end
+
+    def [](key)
+      read_value(key)
+    end
+
+    def []=(key, value)
+      set_value(key, value)
+    end
+
+    private
+
+      def read_value(name)
+        if @config_values.has_key?(name)
+          @config_values[name]
+        else
+          @defaults.send(name)
+        end
+      end
+
+      def set_value(name, value)
+        @config_values[name] = value
+      end
+
+  end
+end

data/lib/this_data/track_request.rb

@@ -0,0 +1,72 @@
+# Include ThisData::TrackRequest in your ApplicationController to get a handy
+# track method which looks at the request and current_user variables to
+# generate an event.
+module ThisData
+  module TrackRequest
+    class ThisDataTrackError < StandardError; end
+
+    # Will pull request and user details from the controller, and send an event
+    # to ThisData.
+    def thisdata_track(verb: ThisData::Verbs::LOG_IN)
+      controller = controller_from_env
+      user_details = user_details_from_controller(controller)
+      event = {
+        verb: verb,
+        ip: request.remote_ip,
+        user_agent: request.user_agent,
+        user: user_details
+      }
+
+      ThisData.track(event)
+    rescue => e
+      ThisData.error "Could not track event:"
+      ThisData.error e
+      ThisData.error e.backtrace.limit(5).join("\n")
+      false
+    end
+
+    private
+
+      # Rails keeps a reference to the controller in the env variable.
+      # Returns a Controller
+      def controller_from_env
+        unless controller = env["action_controller.instance"]
+          raise ThisDataTrackError, "Could not get controller from environment"
+        end
+        controller
+      end
+
+      # Fetches the user record by calling the configured method on the
+      # controller.
+      # Will raise a NoMethodError if controller does not respond to the method.
+      # Returns an object
+      def user_from_controller(controller)
+        user = controller.send(ThisData.configuration.user_method)
+      end
+
+      # Will fetch a user and return a Hash of details for that User.
+      # Will raise a NoMethodError if controller does not return a user,
+      #  or we can't get a user id.
+      def user_details_from_controller(controller)
+        user = user_from_controller(controller)
+        {
+          id:     user.send(ThisData.configuration.user_id_method),
+          name:   value_if_configured(user, "user_name_method"),
+          email:  value_if_configured(user, "user_email_method"),
+          mobile: value_if_configured(user, "user_mobile_method"),
+        }
+      end
+
+      # Will return the result of calling a method defined in ThisData's config
+      # if the object responds to that method.
+      def value_if_configured(object, config_option)
+        method = ThisData.configuration.send("#{config_option}")
+        if object.respond_to?(method, true)
+          return object.send(method)
+        else
+          nil
+        end
+      end
+
+  end
+end

data/lib/this_data/verbs.rb

@@ -0,0 +1,10 @@
+module ThisData
+  class Verbs
+
+    LOG_IN                = 'log-in'
+    LOG_OUT               = 'log-out'
+    LOG_IN_DENIED         = 'log-in-denied'
+    LOG_IN_CHALLENGE      = 'log-in-challenge'
+
+  end
+end

data/lib/this_data/version.rb

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

data/thisdata.gemspec

@@ -0,0 +1,40 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'this_data/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "thisdata"
+  spec.version       = ThisData::VERSION
+  spec.authors       = ["ThisData Ltd", "Nick Malcolm"]
+  spec.email         = ["support@thisdata.com", "nick@thisdata.com"]
+
+  spec.summary       = %q{Ruby wrapper for ThisData's Login Intelligence API}
+  spec.description   = %q{Use ThisData's Login Intelligence API in your ruby / rails app to monitor for unusual end-user activity}
+  spec.homepage      = "https://github.com/thisdata/thisdata-ruby"
+  spec.license       = "MIT"
+
+  # Prevent pushing this gem to RubyGems.org by setting 'allowed_push_host', or
+  # delete this section to allow pushing this gem to any host.
+  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 { |f| f.match(%r{^(test|spec|features)/}) }
+
+  spec.executables   = []
+  spec.require_paths = ["lib"]
+
+  spec.add_runtime_dependency "httparty", "~> 0.13"
+  spec.add_runtime_dependency "json", "~> 1.8"
+
+  spec.add_development_dependency "bundler", "~> 1.10"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "minitest", "~> 5.8"
+  spec.add_development_dependency "fakeweb", "~> 1.3"
+  spec.add_development_dependency "mocha", "~> 1.1"
+
+
+end

metadata

@@ -0,0 +1,162 @@
+--- !ruby/object:Gem::Specification
+name: thisdata
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- ThisData Ltd
+- Nick Malcolm
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-02-22 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.13'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.13'
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+- !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: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.8'
+- !ruby/object:Gem::Dependency
+  name: fakeweb
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: mocha
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+description: Use ThisData's Login Intelligence API in your ruby / rails app to monitor
+  for unusual end-user activity
+email:
+- support@thisdata.com
+- nick@thisdata.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- CHANGELOG
+- Gemfile
+- LICENSE.md
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/generators/this_data/install_generator.rb
+- lib/this_data.rb
+- lib/this_data/client.rb
+- lib/this_data/configuration.rb
+- lib/this_data/track_request.rb
+- lib/this_data/verbs.rb
+- lib/this_data/version.rb
+- thisdata.gemspec
+homepage: https://github.com/thisdata/thisdata-ruby
+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.4.8
+signing_key: 
+specification_version: 4
+summary: Ruby wrapper for ThisData's Login Intelligence API
+test_files: []