ravelin 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: ace9b2ca5a0ad8ebc0db1a5d1b1c4d13138a1b80
+  data.tar.gz: d5040e417b5abd918aea069c6ae8453d7537ecc1
+SHA512:
+  metadata.gz: 024cc6dd06228437355c2ca1132b5e105c4335f0201cb3667132c5c77fbeceef3e6dbbef1627ca6f4b79d7b941178837ad7de81edac9abaabae4682e0c0f9403
+  data.tar.gz: c8c5938e1205e7c2fa04b78bf37505290c71eefffb1e2e1b1e2cd63950e4aab562f08348360bf0c87021e95637ab29f8e293322baf8c2306f3c2bda43694d0d2

data/lib/ravelin.rb

@@ -0,0 +1,56 @@
+require 'date'
+require 'json'
+require 'faraday'
+require 'faraday_middleware'
+
+require 'ravelin/version'
+
+require 'ravelin/errors/api_error'
+require 'ravelin/errors/invalid_request_error'
+require 'ravelin/errors/authentication_error'
+require 'ravelin/errors/rate_limit_error'
+
+require 'ravelin/ravelin_object'
+require 'ravelin/chargeback'
+require 'ravelin/customer'
+require 'ravelin/device'
+require 'ravelin/item'
+require 'ravelin/location'
+require 'ravelin/order'
+require 'ravelin/payment_method'
+require 'ravelin/pre_transaction'
+require 'ravelin/transaction'
+
+require 'ravelin/event'
+require 'ravelin/response'
+require 'ravelin/client'
+
+module Ravelin
+  @faraday_adapter = Faraday.default_adapter
+  @faraday_timeout = 1
+
+  class << self
+    attr_accessor :faraday_adapter, :faraday_timeout
+
+    def camelize(str)
+      str.to_s.gsub(/_(.)/) { |e| $1.upcase }
+    end
+
+    def datetime_to_epoch(val)
+      case val
+      when Date
+        val.to_datetime.to_time.to_i
+      when DateTime
+        val.to_time.to_i
+      when Time
+        val.to_i
+      else
+        val.to_i
+      end
+    end
+
+    def convert_ids_to_strings(key, value)
+      key.to_s.match(/_id\Z/) && value.is_a?(Integer) ? value.to_s : value
+    end
+  end
+end

data/lib/ravelin/chargeback.rb

@@ -0,0 +1,15 @@
+module Ravelin
+  class Chargeback < RavelinObject
+    attr_accessor :chargeback_id,
+      :gateway,
+      :gateway_reference,
+      :reason,
+      :status,
+      :amount,
+      :currency,
+      :dispute_time,
+      :custom
+
+    attr_required :chargeback_id, :gateway, :gateway_reference
+  end
+end

data/lib/ravelin/client.rb

@@ -0,0 +1,69 @@
+module Ravelin
+  class Client
+    API_BASE = 'https://api.ravelin.com'
+
+    def initialize(api_key:)
+      @api_key = api_key
+
+      @connection = Faraday.new(API_BASE, faraday_options) do |conn|
+        conn.response :json, context_type: /\bjson$/
+        conn.adapter Ravelin.faraday_adapter
+      end
+    end
+
+    def send_event(**args)
+      score = args.delete(:score)
+      event = Event.new(**args)
+
+      score_param = score ? "?score=true" : nil
+
+      post("/v2/#{event.name}#{score_param}", event.serializable_hash)
+    end
+
+    def send_backfill_event(**args)
+      unless args.has_key?(:timestamp)
+        raise ArgumentError.new('missing parameters: timestamp')
+      end
+
+      event = Event.new(**args)
+
+      post("/v2/backfill/#{event.name}", event.serializable_hash)
+    end
+
+    private
+
+    def post(url, payload)
+      response = @connection.post(url, payload.to_json)
+
+      if response.success?
+        return Response.new(response)
+      else
+        handle_error_response(response)
+      end
+    end
+
+    def handle_error_response(response)
+      case response.status
+      when 400, 403, 404, 405, 406
+        raise InvalidRequestError.new(response)
+      when 401
+        raise AuthenticationError.new(response)
+      when 429
+        raise RateLimitError.new(response)
+      else
+        raise ApiError.new(response)
+      end
+    end
+
+    def faraday_options
+      {
+        request: { timeout: Ravelin.faraday_timeout },
+        headers: {
+          'Authorization' => "token #{@api_key}",
+          'Content-Type'  => 'application/json; charset=utf-8'.freeze,
+          'User-Agent'    => "Ravelin RubyGem/#{Ravelin::VERSION}".freeze
+        }
+      }
+    end
+  end
+end

data/lib/ravelin/customer.rb

@@ -0,0 +1,26 @@
+module Ravelin
+  class Customer < RavelinObject
+    attr_accessor :customer_id,
+      :registration_time,
+      :name,
+      :given_name,
+      :family_name,
+      :date_of_birth,
+      :gender,
+      :email,
+      :email_verified_time,
+      :user_name,
+      :telephone,
+      :telephone_verified_time,
+      :telephone_country,
+      :location,
+      :country,
+      :custom
+
+    attr_required :customer_id
+
+    def location=(obj)
+      @location = Ravelin::Location.new(obj)
+    end
+  end
+end

data/lib/ravelin/device.rb

@@ -0,0 +1,14 @@
+module Ravelin
+  class Device < RavelinObject
+    attr_accessor :device_id,
+      :type,
+      :manufacturer,
+      :model,
+      :os,
+      :ip_address,
+      :browser,
+      :javascript_enabled,
+      :cookies_enabled,
+      :screen_resolution
+  end
+end

data/lib/ravelin/errors/api_error.rb

@@ -0,0 +1,19 @@
+module Ravelin
+  class ApiError < StandardError
+    attr_reader :response, :status, :error, :error_message, :validation_errors
+
+    def initialize(response)
+      @response           = response
+      @status             = response.status
+      @error              = response.body.fetch('Error', nil)
+      @error_message      = response.body.fetch('message', nil)
+      @validation_errors  = response.body.fetch('validationErrors', [])
+    end
+
+    def to_s
+      parts = [self.status, self.error, self.error_message]
+      parts << self.validation_errors.join('; ') if self.validation_errors.any?
+      parts.compact.join(' - ')
+    end
+  end
+end

data/lib/ravelin/errors/authentication_error.rb

@@ -0,0 +1,4 @@
+module Ravelin
+  class AuthenticationError < ApiError
+  end
+end

data/lib/ravelin/errors/invalid_request_error.rb

@@ -0,0 +1,4 @@
+module Ravelin
+  class InvalidRequestError < ApiError
+  end
+end

data/lib/ravelin/errors/rate_limit_error.rb

@@ -0,0 +1,4 @@
+module Ravelin
+  class RateLimitError < ApiError
+  end
+end

data/lib/ravelin/event.rb

@@ -0,0 +1,114 @@
+module Ravelin
+  class Event
+    attr_accessor :name, :timestamp, :payload
+
+    def initialize(name:, payload:, timestamp: nil)
+      @name = convert_event_name(name)
+      @payload = convert_to_ravelin_objects(payload)
+      @timestamp = timestamp.nil? ? Time.now.to_i : convert_to_epoch(timestamp)
+
+      validate_top_level_payload_params
+    end
+
+    def serializable_hash
+      payload_hash = hash_map(self.payload) do |k, v|
+        k = Ravelin.camelize(k)
+
+        if v.is_a?(Ravelin::RavelinObject)
+          [k, v.serializable_hash]
+        else
+          [k, v]
+        end
+      end
+
+      payload_hash.merge('timestamp' => timestamp)
+    end
+
+    def object_classes
+      {
+        chargeback:     Chargeback,
+        customer:       Customer,
+        device:         Device,
+        location:       Location,
+        order:          Order,
+        payment_method: PaymentMethod,
+        transaction:    self.name == :pretransaction ? PreTransaction : Transaction
+      }
+    end
+
+    private
+
+    def validate_top_level_payload_params
+      validate_customer_id_presence_on :order, :paymentmethod,
+        :pretransaction, :transaction
+
+      case self.name
+        when :customer
+          validate_payload_inclusion_of :customer
+        when :pretransaction, :transaction
+          validate_payload_inclusion_of :order_id, :payment_method_id
+        when :login
+          validate_payload_inclusion_of :customer_id, :temp_customer_id
+        when :checkout
+          validate_payload_inclusion_of :customer, :order,
+            :payment_method, :transaction
+      end
+    end
+
+    def validate_customer_id_presence_on(*events)
+      if events.include?(self.name) && !payload_customer_reference_present?
+        raise ArgumentError.
+          new(%q{payload missing customer_id or temp_customer_id parameter})
+      end
+    end
+
+    def validate_payload_inclusion_of(*required_keys)
+      missing = required_keys - self.payload.keys
+
+      if missing.any?
+        raise ArgumentError.
+          new(%Q{payload missing parameters: #{missing.join(', ')}})
+      end
+    end
+
+    def payload_customer_reference_present?
+      self.payload.keys.any? {|k| %i(customer_id temp_customer_id).include? k }
+    end
+
+    def convert_to_epoch(val)
+      if val.is_a?(Time) || val.is_a?(Date) || val.is_a?(DateTime)
+        Ravelin.datetime_to_epoch(val)
+      elsif val.is_a?(Integer)
+        val
+      else
+        raise TypeError.new(%Q{timestamp requires a Time or epoch Integer})
+      end
+    end
+
+    def convert_to_ravelin_objects(payload)
+      hash_map(payload) do |k, v|
+        k = k.to_sym
+        v = Ravelin.convert_ids_to_strings(k, v)
+
+        if v.is_a?(Hash) && klass = object_classes[k]
+          [k, klass.new(v)]
+        else
+          [k, v]
+        end
+      end
+    end
+
+    def convert_event_name(str)
+      underscore_mapping = {
+        payment_method: :paymentmethod,
+        pre_transaction: :pretransaction
+      }
+
+      underscore_mapping.fetch(str.to_sym, str.to_sym)
+    end
+
+    def hash_map(hash, &block)
+      Hash[hash.map { |k, v| block.call(k, v) }]
+    end
+  end
+end

data/lib/ravelin/item.rb

@@ -0,0 +1,15 @@
+module Ravelin
+  class Item < RavelinObject
+    attr_accessor :sku,
+      :name,
+      :price,
+      :currency,
+      :brand,
+      :upc,
+      :category,
+      :quantity,
+      :custom
+
+    attr_required :sku, :quantity
+  end
+end

data/lib/ravelin/location.rb

@@ -0,0 +1,18 @@
+module Ravelin
+  class Location < RavelinObject
+    attr_accessor :location_id,
+      :street1,
+      :street2,
+      :neighbourhood,
+      :zone,
+      :city,
+      :region,
+      :country,
+      :po_box_number,
+      :postal_code,
+      :latitude,
+      :longitude,
+      :geohash,
+      :custom
+  end
+end

data/lib/ravelin/order.rb

@@ -0,0 +1,34 @@
+module Ravelin
+  class Order < RavelinObject
+    attr_accessor :order_id,
+      :email,
+      :price,
+      :currency,
+      :seller_id,
+      :items,
+      :from,
+      :to,
+      :country,
+      :market,
+      :custom,
+      :creation_time,
+      :execution_time,
+      :status
+
+    attr_required :order_id
+
+    def items=(arr)
+      raise ArgumentError.new('items= requires an Array') unless arr.is_a?(Array)
+
+      @items = arr.map { |item| Ravelin::Item.new(item) }
+    end
+
+    def from=(obj)
+      @from = Ravelin::Location.new(obj)
+    end
+
+    def to=(obj)
+      @to = Ravelin::Location.new(obj)
+    end
+  end
+end

data/lib/ravelin/payment_method.rb

@@ -0,0 +1,27 @@
+module Ravelin
+  class PaymentMethod < RavelinObject
+    attr_accessor :payment_method_id,
+      :nick_name,
+      :method_type,
+      :banned,
+      :active,
+      :registration_time,
+      # Only when type = card
+      :instrument_id,
+      :name_on_card,
+      :card_bin,
+      :card_last_four,
+      :card_type,
+      :expiry_month,
+      :expiry_year,
+      :successful_registration,
+      :prepaid_card,
+      :issuer,
+      :country_issued,
+      # Only when type = paypal
+      :email,
+      :custom
+
+    attr_required :payment_method_id, :method_type
+  end
+end

data/lib/ravelin/pre_transaction.rb

@@ -0,0 +1,13 @@
+module Ravelin
+  class PreTransaction < RavelinObject
+    attr_accessor :transaction_id,
+      :email,
+      :currency,
+      :debit,
+      :credit,
+      :gateway,
+      :custom
+
+    attr_required :transaction_id, :currency, :debit, :credit, :gateway
+  end
+end

data/lib/ravelin/ravelin_object.rb

@@ -0,0 +1,56 @@
+module Ravelin
+  class RavelinObject
+    class << self
+      attr_reader :attr_accessor_names
+
+      def required_attributes
+        @required_attributes ||= []
+      end
+
+      def attr_required(*names)
+        @required_attributes = *names
+      end
+
+      def attr_accessor(*names)
+        @attr_accessor_names ||= []
+        @attr_accessor_names.concat(names)
+        super
+      end
+    end
+
+    def initialize(args)
+      args.each do |key, value|
+        self.send("#{key}=", Ravelin.convert_ids_to_strings(key, value))
+      end
+
+      validate
+    end
+
+    def validate
+      missing = self.class.required_attributes.select do |name|
+        self.send(name).nil? || self.send(name) == ''
+      end
+
+      if missing.any?
+        raise ArgumentError.new(%Q{missing parameters: #{missing.join(', ')}})
+      end
+    end
+
+    def serializable_hash
+      self.class.attr_accessor_names.each_with_object({}) do |key, hash|
+        value = self.send(key)
+        key = Ravelin.camelize(key)
+
+        if value.is_a?(RavelinObject)
+          hash[key] = value.serializable_hash
+        elsif value.is_a?(Array)
+          hash[key] = value.map(&:serializable_hash)
+        elsif value.is_a?(Time) || value.is_a?(Date) || value.is_a?(DateTime)
+          hash[key] = Ravelin.datetime_to_epoch(value)
+        elsif !value.nil?
+          hash[key] = value
+        end
+      end
+    end
+  end
+end

data/lib/ravelin/response.rb

@@ -0,0 +1,26 @@
+module Ravelin
+  class Response
+    attr_reader :customer_id,
+      :action,
+      :score,
+      :score_id,
+      :source,
+      :comment,
+      :http_status,
+      :http_body
+
+    def initialize(faraday_response)
+      data = faraday_response.body.fetch('data', {})
+
+      @customer_id  = data['customerId']
+      @action       = data['action']
+      @score        = data['score']
+      @score_id     = data['scoreId']
+      @source       = data['source']
+      @comment      = data['comment']
+      @customer_id  = data['customerId']
+      @http_status  = faraday_response.status
+      @http_body    = faraday_response.body
+    end
+  end
+end

data/lib/ravelin/transaction.rb

@@ -0,0 +1,25 @@
+module Ravelin
+  class Transaction < RavelinObject
+    attr_accessor :transaction_id,
+      :email,
+      :currency,
+      :debit,
+      :credit,
+      :gateway,
+      :custom,
+      :success,
+      :auth_code,
+      :decline_code,
+      :gateway_reference,
+      :avs_result_code,
+      :cvv_result_code
+
+    attr_required :transaction_id,
+      :currency,
+      :debit,
+      :credit,
+      :gateway,
+      :gateway_reference,
+      :success
+  end
+end

data/lib/ravelin/version.rb

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

metadata

@@ -0,0 +1,150 @@
+--- !ruby/object:Gem::Specification
+name: ravelin
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Sam Levy
+- Tommy Palmer
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-06-17 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+- !ruby/object:Gem::Dependency
+  name: faraday_middleware
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+- !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: '1.22'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.22'
+description: Ravelin is a fraud detection tool. See https://www.ravelin.com for details.
+email:
+- sam.levy@deliveroo.co.uk
+- tommy.palmer@deliveroo.co.uk
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/ravelin.rb
+- lib/ravelin/chargeback.rb
+- lib/ravelin/client.rb
+- lib/ravelin/customer.rb
+- lib/ravelin/device.rb
+- lib/ravelin/errors/api_error.rb
+- lib/ravelin/errors/authentication_error.rb
+- lib/ravelin/errors/invalid_request_error.rb
+- lib/ravelin/errors/rate_limit_error.rb
+- lib/ravelin/event.rb
+- lib/ravelin/item.rb
+- lib/ravelin/location.rb
+- lib/ravelin/order.rb
+- lib/ravelin/payment_method.rb
+- lib/ravelin/pre_transaction.rb
+- lib/ravelin/ravelin_object.rb
+- lib/ravelin/response.rb
+- lib/ravelin/transaction.rb
+- lib/ravelin/version.rb
+homepage: https://developer.ravelin.com
+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: []
+rubyforge_project: 
+rubygems_version: 2.4.5.1
+signing_key: 
+specification_version: 4
+summary: Ruby bindings for the Ravelin API
+test_files: []
+has_rdoc: