genderize-io 0.1.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6be289a2888af4bf3942e5cd4a876343c45c0f8d23f9a9291e9d510cbcb24a8e
-  data.tar.gz: 64d7cc82232bfdcc6508f01f7810b0bd343e8cf3a88b4ce7f6b54d414ad081cd
+  metadata.gz: ebc6e06738af6ebd88bea0db2a23de063cf8105bf7496bb438853bf643cdbba4
+  data.tar.gz: 9bd34f44ae411ac7c66c6d9f5b8b7844697cda77409d064cf334effd76210568
 SHA512:
-  metadata.gz: c2ae2db8659c0c856d235cf80a11f34defed927dfcf0a0aeea941244bc3125ed75033427aac005d66ba622245027d760fd64a358f8cdef38c77210a663e9c32a
-  data.tar.gz: 0b77aaa2ed9df12fb37efbefa30eacf12ba7a1264ae16789a4cda9cb08ae80ee66be726bff8e7b9c9b5b2c6328a887894b48e0c09e27b0d0337823e115f5e307
+  metadata.gz: 4fb103eaa24e8e7d1e9ebacc4b91aa02ab09c4c68a8a23a43e49a2d3b6c69fcc6250765feb7292f89cc43c47446f58fe218292854539a9ae7d80abbb7d685be2
+  data.tar.gz: e912b7613bde5cdbb9055345cf989b60462f86329f8b4ed608194276569c6276ee7c81e2416737bedbb560060f5aa9826ac37dbc0feb420db04e250770c4744c

data/.reek

@@ -3,6 +3,8 @@ BooleanParameter:
   enabled: false
 DuplicateMethodCall:
   enabled: false
+FeatureEnvy:
+  enabled: false
 InstanceVariableAssumption:
   enabled: false
 IrresponsibleModule:
@@ -11,6 +13,8 @@ LongParameterList:
   enabled: false
 NilCheck:
   enabled: false
+RepeatedConditional:
+  enabled: false
 TooManyInstanceVariables:
   enabled: false
 TooManyStatements:

data/README.md

@@ -3,7 +3,8 @@
 [![Gem Version](https://badge.fury.io/rb/genderize-io.svg)](http://badge.fury.io/rb/genderize-io)
 [![Build Status](https://travis-ci.org/drexed/genderize-io.svg?branch=master)](https://travis-ci.org/drexed/genderize-io)
 
-API wrapper for the free [Genderize.io](https://genderize.io) gender determination system.
+API wrapper for the [Genderize.io](https://genderize.io) first name gender determination system.
+*Be aware that the free API has a limit of 1000 determinations per day.*
 
 ## Installation
 
@@ -22,22 +23,27 @@ Or install it yourself as:
     $ gem install genderize-io
 
 ## Usage
+
+### Lookup Determination
+
 ```ruby
 # Basic Lookup
-lookup = Genderize::Io::Lookup.new('kim').verify
-lookup = Genderize::Io::Lookup.verify('kim')
+lookup = Genderize::Io::Lookup.new('kim').determine
+lookup = Genderize::Io::Lookup.determine('kim')
 
-# Custom Host
-lookup = Genderize::Io::Lookup.new('kim', host: 'https://api.genderize.io?api_key=xxx').verify
-lookup = Genderize::Io::Lookup.verify('kim', host: 'https://api.genderize.io?api_key=xxx')
+# Custom Options
+lookup = Genderize::Io::Lookup.determine('kim', host: 'https://api.genderize.io?api_key=xxx',
+                                                country_id: 'dk',
+                                                language_id: 'en')
+```
 
-# Custom IDs
-lookup = Genderize::Io::Lookup.new('kim', country_id: 'dk').verify
-lookup = Genderize::Io::Lookup.verify('kim', language_id: 'en')
+### Lookup Methods
 
-# Public Methods
+```ruby
 lookup.url                    => 'https://api.genderize.io?name=kim'
-lookup.to_h                   => { 'name' => 'kim', 'gender' => 'female', ... }
+lookup.data                   => { 'name' => 'kim', 'gender' => 'female', ... }
+
+# Data Methods
 lookup.name                   => 'kim'
 lookup.gender                 => 'female'
 lookup.probability            => 0.94
@@ -50,6 +56,32 @@ lookup.x_rate_reset           => 13829
 lookup.error                  => 'sorry, my bad!'
 ```
 
+### Batch Lookup Determination
+
+```ruby
+# Basic Lookup
+lookup = Genderize::Io::Batch::Lookup.new(['kim', 'jim']).determine
+lookup = Genderize::Io::Batch::Lookup.determine(['kim', 'jim'])
+
+# Custom Options
+lookup = Genderize::Io::Batch::Lookup.determine(['kim', 'jim'], host: 'https://api.genderize.io?api_key=xxx',
+                                                                country_id: 'dk',
+                                                                language_id: 'en')
+```
+
+### Batch Lookup Methods
+
+```ruby
+lookup.url  => 'https://api.genderize.io?name[0]=kim&name[1]=jim'
+lookup.data => {
+                 'rate_limits' => { 'x_rate_limit_limit' => 1069, ... },
+                 'responses' => [
+                   { 'name' => 'kim', 'gender' => 'female', ... },
+                   { 'name' => 'jim', 'gender' => 'male', ... }
+                 ]
+               }
+```
+
 ## Contributing
 
 Your contribution is welcome.

data/lib/genderize/io.rb

@@ -4,6 +4,7 @@
   require "genderize/io/parser/#{file_name}"
 end
 
-%w[version lookup].each do |file_name|
+%w[version base lookup].each do |file_name|
   require "genderize/io/#{file_name}"
+  require "genderize/io/batch/#{file_name}" if file_name == 'lookup'
 end

data/lib/genderize/io/base.rb

@@ -0,0 +1,68 @@
+# frozen_string_literal: true
+
+require 'typhoeus'
+require 'user_agent_db'
+
+module Genderize
+  module Io
+    class Base
+
+      DEFAULT_HOST ||= 'https://api.genderize.io'
+      HEADER_KEYS ||= %w[x_rate_limit_limit x_rate_limit_remaining x_rate_reset].freeze
+
+      attr_reader :country_id, :data, :host, :language_id, :name, :request
+
+      def initialize(name, host: DEFAULT_HOST, country_id: nil, language_id: nil)
+        @name = name
+        @host = host
+        @country_id = country_id
+        @language_id = language_id
+        @request = nil
+      end
+
+      def self.determine(name, host: DEFAULT_HOST, country_id: nil, language_id: nil)
+        klass = new(name, host: host, country_id: country_id, language_id: language_id)
+        klass.determine
+        klass
+      end
+
+      def url
+        connector = @host.include?('?') ? '&' : '?'
+        "#{@host}#{connector}#{param_name}#{param_country_id}#{param_language_id}"
+      end
+
+      private
+
+      def generate_data
+        return if @request.nil?
+        Genderize::Io::Parser::Json.parse(@request.response_body)
+      end
+
+      def generate_headers
+        return if @request.nil?
+        Genderize::Io::Parser::Header.parse(@request.response_headers)
+      end
+
+      def generate_rate_limits
+        headers = generate_headers
+        return if headers.nil?
+        HEADER_KEYS.each_with_object({}) { |key, hash| hash[key] = headers.send(key).to_i }
+      end
+
+      def generate_request
+        return @request unless @request.nil?
+        Typhoeus::Config.user_agent = UserAgentDB.random
+        Typhoeus.get(url, accept_encoding: 'gzip,deflate')
+      end
+
+      def param_country_id
+        "&country_id=#{@country_id}" unless @country_id.nil?
+      end
+
+      def param_language_id
+        "&language_id=#{@language_id}" unless @language_id.nil?
+      end
+
+    end
+  end
+end

data/lib/genderize/io/batch/lookup.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+module Genderize
+  module Io
+    module Batch
+      class Lookup < Genderize::Io::Base
+
+        def initialize(name, host: DEFAULT_HOST, country_id: nil, language_id: nil)
+          super(name, host: host, country_id: country_id, language_id: language_id)
+          @data = {
+            'rate_limits' => {},
+            'responses' => []
+          }
+        end
+
+        def determine
+          return @data unless @request.nil?
+
+          @request = generate_request
+          @data['responses'] = generate_data
+          @data['rate_limits'] = generate_rate_limits
+        end
+
+        private
+
+        def param_name
+          @name.map.with_index { |name, i| "name[#{i}]=#{name}" }.join('&')
+        end
+
+      end
+    end
+  end
+end

data/lib/genderize/io/lookup.rb

@@ -1,82 +1,35 @@
 # frozen_string_literal: true
 
-require 'typhoeus'
-require 'user_agent_db'
-
 module Genderize
   module Io
-    class Lookup
-
-      DEFAULT_HOST ||= 'https://api.genderize.io'
-      RESPONSE_KEYS ||= %w[
-        count country_id error language_id gender probability x_rate_limit_limit
-        x_rate_limit_remaining x_rate_reset
-      ].freeze
+    class Lookup < Genderize::Io::Base
 
-      attr_reader :country_id, :hash, :host, :language_id, :name, :response
+      RESPONSE_KEYS ||= %w[count country_id error language_id gender probability].freeze
 
       def initialize(name, host: DEFAULT_HOST, country_id: nil, language_id: nil)
-        @name = name
-        @host = host
-        @country_id = country_id
-        @language_id = language_id
-        @response = nil
-        @hash = {}
-      end
-
-      def self.verify(name, host: DEFAULT_HOST, country_id: nil, language_id: nil)
-        klass = new(name, host: host, country_id: country_id, language_id: language_id)
-        klass.verify
-        klass
+        super(name, host: host, country_id: country_id, language_id: language_id)
+        @data = {}
       end
 
-      def verify
-        return @hash unless @response.nil?
+      def determine
+        return @data unless @request.nil?
 
-        Typhoeus::Config.user_agent = UserAgentDB.random
-        @response = Typhoeus.get(url, accept_encoding: 'gzip,deflate')
-
-        generate_hash
-        generate_rate_limits
-      end
-
-      def url
-        connector = @host.include?('?') ? '&' : '?'
-        "#{@host}#{connector}#{param_name}#{param_country_id}#{param_language_id}"
+        @request = generate_request
+        @data = generate_data.merge(generate_rate_limits)
       end
 
-      def to_h
-        @hash
+      HEADER_KEYS.each do |key|
+        define_method(key) { @data[key] }
       end
 
       RESPONSE_KEYS.each do |key|
-        define_method(key) { @hash[key] }
+        define_method(key) { @data[key] }
       end
 
       private
 
-      def generate_hash
-        return if @response.response_body.nil?
-        @hash = Genderize::Io::Parser::Json.parse(@response.response_body)
-      end
-
-      def generate_rate_limits
-        return if @response.response_headers.nil?
-        headers = Genderize::Io::Parser::Header.parse(@response.response_headers)
-        RESPONSE_KEYS.last(3).each { |key| @hash[key] = headers.send(key).to_i }
-      end
-
       def param_name
-        return "name=#{@name}" unless @name.is_a?(Array)
-        @name.map.with_index { |name, i| "name[#{i}]=#{name}" }.join('&')
-      end
-
-      def param_country_id
-        "&country_id=#{@country_id}" unless @country_id.nil?
-      end
-
-      def param_language_id
-        "&language_id=#{@language_id}" unless @language_id.nil?
+        "name=#{@name}"
       end
 
     end

data/lib/genderize/io/version.rb

@@ -2,6 +2,6 @@
 
 module Genderize
   module Io
-    VERSION ||= '0.1.0'
+    VERSION ||= '1.0.0'
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: genderize-io
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 1.0.0
 platform: ruby
 authors:
 - Juan Gomez
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-11-28 00:00:00.000000000 Z
+date: 2017-11-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: typhoeus
@@ -145,6 +145,8 @@ files:
 - bin/setup
 - genderize-io.gemspec
 - lib/genderize/io.rb
+- lib/genderize/io/base.rb
+- lib/genderize/io/batch/lookup.rb
 - lib/genderize/io/lookup.rb
 - lib/genderize/io/parser/header.rb
 - lib/genderize/io/parser/json.rb