minfraud 1.0.0 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3dd67d789e955bf5a4d4bb1b1900439ae8a3b386
-  data.tar.gz: a6b08f07d7adf54d3df09823bb17b5d53644c354
+  metadata.gz: 6a55c03cbdb1487ae09c4e1e8b0286b53f49ae98
+  data.tar.gz: 436b76d31314d1971fd511cce43e05d1cf80f1f4
 SHA512:
-  metadata.gz: f55e059b7e4d96be4d6b92247c3580bb4b5be5299a4f59264e2eaaf9c913e2b0c4ee1ac2b8786282c8bd255ffb343772e4311115343eff106c4e6c6dc91695aa
-  data.tar.gz: 85f7b208c1d116987a4754355d7ee4ec2295ea6a151a741eaf29d3280ba4ad8dcf04397817d454cced3cf712abbca6a687da19356cba66445bfb31af8d54d315
+  metadata.gz: febcdcdfc8828f99424d485f041f621ef9763b2eca5f2b7a401b5ad54b2f1b312711d47c782cd8f986848fdac46a749e17621e88f86bb98e9e6693cde3d8980a
+  data.tar.gz: 28279d249f2cc2495e4223337900f90c875eb48e6a667a75c994a8dc8ff19a9d0512b1914eac748e60a8a16a0d0973ee179f77c77657b4dad1185fdd2199cb3b

data/README.md

@@ -40,11 +40,6 @@ end
 
 ## Usage
 ```ruby
-Minfraud.configure do |c|
-  c.user_id     = 'user_id' # your minFraud user id
-  c.license_key = 'license_key' # your minFraud license key
-end
-
 # You can either provide a hash of params to initializer
 assessment = Minfraud::Assessments.new(
   device: {
@@ -57,18 +52,22 @@ assessment = Minfraud::Assessments.new(device: device)
 # or
 assessment = Minfraud::Assessments.new
 assessment.device = device
+# There are multiple components that reflect minFraud request top level keys
 
+# Some components will raise an error if provided with the wrong values for attributes, e.g
+event = Minfraud::Components::Event.new(type: 'foobar') # => Minfraud::NotEnumValueError
+# You can check the list of permitted values for the attribute by calling a class method
+Minfraud::Components::Event.type_values # => ["account_creation", "account_login", ....]
 
-# There are multiple components that reflect minFraud request top level keys
 # You can now call 3 different minFraud endpoints: score, insights, factors
 assessment.insights
 assessment.factors
 
 result = assessment.score # => Minfraud::Response instance
 
-result.status # => Response status code
-result.code # => minFraud specific response code
-result.body # => Mashified body
+result.status  # => Response status code
+result.code    # => minFraud specific response code
+result.body    # => Mashified body
 result.headers # => Response headers
 
 # You can also change data inbetween requests
@@ -93,13 +92,13 @@ class AuthorizationError < BaseError; end
 # Raised if minFraud returns an error, or if there is an HTTP error
 class ServerError < BaseError; end
 
-# Raised if assigned value does not belong to enum list
+# Raised if an attribute value doesn't belong to the predefined set of values
 class NotEnumValueError < BaseError; end
 ```
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at [https://github.com/kushniryb/minfraud-api-v2]. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+Bug reports and pull requests are welcome on GitHub [here](https://github.com/kushniryb/minfraud-api-v2). This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
 
 
 ## License

data/lib/minfraud.rb

@@ -38,7 +38,7 @@ module Minfraud
       yield self
     end
 
-    # @return [Hash] with the current configuration
+    # @return [Hash] current Minfraud configuration
     def configuration
       {
         user_id:     @user_id,

data/lib/minfraud/assessments.rb

@@ -45,16 +45,20 @@ module Minfraud
 
     # @param  [Hash] params hash of parameters
     # @param  [Minfraud::Resolver] resolver resolver that maps params to components
+    # In case if params is a Hash of components it just assignes them to corresponding
+    # instance variables
     # @return [Minfraud::Assessments] Assessments instance
     def initialize(params = {}, resolver = ::Minfraud::Resolver)
       resolver.assign(context: self, params: params)
     end
 
-    # These methods correspond to the minFraud API endpoints and require the same set of params
-    # Raises an error in case of invalid response
-    # @return [Minfraud::HTTPService::Response] Wrapped minFraud response
-    %w(score insights factors).each do |endpoint|
-      define_method endpoint do
+    # @!macro [attach] define
+    #   @method $1
+    #   Makes a request to minFraud $1 endpoint.
+    #   Raises an error in case of invalid response
+    #   @return [Minfraud::HTTPService::Response] Wrapped minFraud response
+    def self.define(endpoint)
+      define_method(endpoint) do
         raw       = request.perform(verb: :post, endpoint: endpoint, body: request_body)
         response  = ::Minfraud::HTTPService::Response.new(
           status:  raw.status.to_i,
@@ -66,6 +70,10 @@ module Minfraud
       end
     end
 
+    define :score
+    define :insights
+    define :factors
+
     private
     # Creates a unified request body from components converted to JSON
     # @return [Hash] Request body

data/lib/minfraud/components/account.rb

@@ -13,7 +13,7 @@ module Minfraud
 
       # Creates Minfraud::Components::Account instance
       # @param  [Hash] params hash of parameters
-      # @return [Minfraud::Components::Account] a Account instance
+      # @return [Minfraud::Components::Account] an Account instance
       def initialize(params = {})
         @user_id      = params[:user_id]
         @username_md5 = params[:username_md5]

data/lib/minfraud/components/event.rb

@@ -32,7 +32,7 @@ module Minfraud
         @transaction_id = params[:transaction_id]
         @shop_id        = params[:shop_id]
         @time           = params[:time]
-        @type           = params[:type]
+        self.type       = params[:type]
       end
     end
   end

data/lib/minfraud/components/payment.rb

@@ -33,7 +33,7 @@ module Minfraud
       def initialize(params = {})
         @was_authorized = params[:was_authorized]
         @decline_code   = params[:decline_code]
-        @processor      = params[:processor]
+        self.processor  = params[:processor]
       end
     end
   end

data/lib/minfraud/components/shipping.rb

@@ -14,7 +14,7 @@ module Minfraud
       # @param  [Hash] params hash of parameters
       # @return [Minfraud::Components::Shipping] Shipping instance
       def initialize(params = {})
-        @delivery_speed = params[:delivery_speed]
+        self.delivery_speed = params[:delivery_speed]
         super
       end
     end

data/lib/minfraud/components/shopping_cart.rb

@@ -20,9 +20,10 @@ module Minfraud
       private
 
       # @param  [Hash] params hash of parameters for Minfraud::Components::ShoppingCartItem
+      # or Minfraud::Components::ShoppingCartItem instance
       # @return [Minfraud::Components::ShoppingCart] ShoppingCart instance
       def resolve(params)
-        ShoppingCartItem.new(params)
+        params.is_a?(ShoppingCartItem) ? params : ShoppingCartItem.new(params)
       end
     end
   end

data/lib/minfraud/enum.rb

@@ -5,12 +5,17 @@ module Minfraud
     end
 
     module ClassMethods
+      # Returns a hash with in the following format: attribute_name => permitted_values
+      # @return [Hash] mapping
       def mapping
         @mapping ||= {}
       end
 
+      # Creates a set of methods for enum-like behaviour of the attribute
+      # @param [Symbol] attribute attribute name
+      # @param [Array] assignable_values a set of values which are permitted
       def enum_accessor(attribute, assignable_values)
-        mapping[attribute] = assignable_values.map(&:to_s)
+        mapping[attribute] = assignable_values.map(&:intern)
 
         self.class.instance_eval do
           define_method("#{attribute}_values") { mapping[attribute] }
@@ -18,10 +23,9 @@ module Minfraud
 
         self.class_eval do
           define_method("#{attribute}") { instance_variable_get("@#{attribute}") }
-
           define_method "#{attribute}=" do |value|
-            raise NotEnumValueError,  'Value is not permitted' unless self.class.mapping[attribute].include?(value.to_s)
-            instance_variable_set("@#{attribute}", value.to_s)
+            raise NotEnumValueError,  'Value is not permitted' if value && !self.class.mapping[attribute].include?(value.intern)
+            instance_variable_set("@#{attribute}", value&.intern)
           end
         end
       end

data/lib/minfraud/http_service/response.rb

@@ -13,10 +13,6 @@ module Minfraud
       # @return [Hash] HTTP response headers
       attr_reader :headers
 
-      # @attribute code
-      # @return [String] minFraud specific HTTP response code
-      attr_reader :code
-
       # Creates Minfraud::HTTPService::Response instance
       # @param  [Hash] params hash of parameters
       # @return [Minfraud::HTTPService::Response] Response instance

data/lib/minfraud/version.rb

@@ -1,3 +1,3 @@
 module Minfraud
-  VERSION = "1.0.0"
+  VERSION = "1.0.1"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: minfraud
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.1
 platform: ruby
 authors:
 - kushnir.yb
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-10-03 00:00:00.000000000 Z
+date: 2016-10-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday