genderize-io 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 6be289a2888af4bf3942e5cd4a876343c45c0f8d23f9a9291e9d510cbcb24a8e
+  data.tar.gz: 64d7cc82232bfdcc6508f01f7810b0bd343e8cf3a88b4ce7f6b54d414ad081cd
+SHA512:
+  metadata.gz: c2ae2db8659c0c856d235cf80a11f34defed927dfcf0a0aeea941244bc3125ed75033427aac005d66ba622245027d760fd64a358f8cdef38c77210a663e9c32a
+  data.tar.gz: 0b77aaa2ed9df12fb37efbefa30eacf12ba7a1264ae16789a4cda9cb08ae80ee66be726bff8e7b9c9b5b2c6328a887894b48e0c09e27b0d0337823e115f5e307

data/.fasterer.yml

@@ -0,0 +1,19 @@
+speedups:
+  rescue_vs_respond_to: true
+  module_eval: true
+  shuffle_first_vs_sample: true
+  for_loop_vs_each: true
+  each_with_index_vs_while: false
+  map_flatten_vs_flat_map: true
+  reverse_each_vs_reverse_each: true
+  select_first_vs_detect: true
+  sort_vs_sort_by: true
+  fetch_with_argument_vs_block: true
+  keys_each_vs_each_key: true
+  hash_merge_bang_vs_hash_brackets: true
+  block_vs_symbol_to_proc: true
+  proc_call_vs_yield: true
+  gsub_vs_tr: true
+  select_last_vs_reverse_detect: true
+  getter_vs_attr_reader: true
+  setter_vs_attr_writer: true

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.reek

@@ -0,0 +1,23 @@
+---
+BooleanParameter:
+  enabled: false
+DuplicateMethodCall:
+  enabled: false
+InstanceVariableAssumption:
+  enabled: false
+IrresponsibleModule:
+  enabled: false
+LongParameterList:
+  enabled: false
+NilCheck:
+  enabled: false
+TooManyInstanceVariables:
+  enabled: false
+TooManyStatements:
+  enabled: false
+UnusedParameters:
+  enabled: false
+UncommunicativeVariableName:
+  enabled: false
+UtilityFunction:
+  enabled: false

data/.rspec

@@ -0,0 +1,4 @@
+--backtrace
+--color
+--format progress
+--order random

data/.rubocop.yml

@@ -0,0 +1,24 @@
+AllCops:
+  DisplayCopNames: true
+  DisplayStyleGuide: true
+  TargetRubyVersion: 2.4
+  Exclude:
+    - 'spec/**/**/*'
+Gemspec/OrderedDependencies:
+  Enabled: false
+Layout/EmptyLinesAroundClassBody:
+  Enabled: false
+Layout/EmptyLinesAroundModuleBody:
+  Enabled: false
+LineLength:
+  Max: 100
+Lint/ScriptPermission:
+  Enabled: false
+Style/Documentation:
+  Enabled: false
+Style/MethodMissing:
+  Enabled: false
+Style/PerlBackrefs:
+  Enabled: false
+Style/RegexpLiteral:
+  Enabled: false

data/.travis.yml

@@ -0,0 +1,13 @@
+before_install:
+  - sudo apt-get install libxml2-dev
+cache: bundler
+language: ruby
+notifications:
+  email:
+    recipients:
+      - j.gomez@drexed.com
+    on_failure: change
+    on_success: never
+rvm:
+  - ruby-head
+script: 'bundle exec rake'

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,13 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, we pledge to respect all people who contribute through reporting issues, posting feature requests, updating documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free experience for everyone, regardless of level of experience, gender, gender identity and expression, sexual orientation, disability, personal appearance, body size, race, age, or religion.
+
+Examples of unacceptable behavior by participants include the use of sexual language or imagery, derogatory comments or personal attacks, trolling, public or private harassment, insults, or other unprofessional conduct.
+
+Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct. Project maintainers who do not follow the Code of Conduct may be removed from the project team.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by opening an issue or contacting one or more of the project maintainers.
+
+This Code of Conduct is adapted from the [Contributor Covenant](http:contributor-covenant.org), version 1.0.0, available at [http://contributor-covenant.org/version/1/0/0/](http://contributor-covenant.org/version/1/0/0/)

data/Gemfile

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in trumail.gemspec
+gemspec

data/README.md

@@ -0,0 +1,61 @@
+# Genderize::Io
+
+[![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.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'genderize-io'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install genderize-io
+
+## Usage
+```ruby
+# Basic Lookup
+lookup = Genderize::Io::Lookup.new('kim').verify
+lookup = Genderize::Io::Lookup.verify('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 IDs
+lookup = Genderize::Io::Lookup.new('kim', country_id: 'dk').verify
+lookup = Genderize::Io::Lookup.verify('kim', language_id: 'en')
+
+# Public Methods
+lookup.url                    => 'https://api.genderize.io?name=kim'
+lookup.to_h                   => { 'name' => 'kim', 'gender' => 'female', ... }
+lookup.name                   => 'kim'
+lookup.gender                 => 'female'
+lookup.probability            => 0.94
+lookup.count                  => 1098
+lookup.country_id             => 'dk'
+lookup.language_id            => 'en'
+lookup.x_rate_limit_limit     => 1000
+lookup.x_rate_limit_remaining => 738
+lookup.x_rate_reset           => 13829
+lookup.error                  => 'sorry, my bad!'
+```
+
+## Contributing
+
+Your contribution is welcome.
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Added some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+
+task default: :spec

data/_config.yml

@@ -0,0 +1 @@
+theme: jekyll-theme-cayman

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'bundler/setup'
+require 'genderize/io'
+
+# 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/rake

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+# This file was generated by Bundler.
+#
+# The application 'rake' is installed as part of a gem, and
+# this file is here to facilitate running it.
+
+require 'pathname'
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../Gemfile', Pathname.new(__FILE__).realpath)
+
+require 'rubygems'
+require 'bundler/setup'
+
+load Gem.bin_path('rake', 'rake')

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/genderize-io.gemspec

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+# coding: utf-8
+
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'genderize/io/version'
+
+Gem::Specification.new do |spec|
+  spec.name = 'genderize-io'
+  spec.version = Genderize::Io::VERSION
+  spec.authors = ['Juan Gomez']
+  spec.email = ['j.gomez@drexed.com']
+
+  spec.summary = 'Genderize.io Ruby SDK.'
+  spec.description = 'Genderize.io Ruby SDK for interacting with the Genderize.io API.'
+  spec.homepage = 'http://drexed.github.io/genderize-io'
+  spec.license = 'MIT'
+
+  spec.files = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir = 'exe'
+  spec.executables = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = %w[lib support]
+
+  spec.add_runtime_dependency 'typhoeus'
+  spec.add_runtime_dependency 'user_agent_db'
+
+  spec.add_development_dependency 'bundler'
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'rspec'
+  spec.add_development_dependency 'fasterer'
+  spec.add_development_dependency 'reek'
+  spec.add_development_dependency 'rubocop'
+end

data/lib/genderize/io.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+%w[json header].each do |file_name|
+  require "genderize/io/parser/#{file_name}"
+end
+
+%w[version lookup].each do |file_name|
+  require "genderize/io/#{file_name}"
+end

data/lib/genderize/io/lookup.rb

@@ -0,0 +1,84 @@
+# 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
+
+      attr_reader :country_id, :hash, :host, :language_id, :name, :response
+
+      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
+      end
+
+      def verify
+        return @hash unless @response.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}"
+      end
+
+      def to_h
+        @hash
+      end
+
+      RESPONSE_KEYS.each do |key|
+        define_method(key) { @hash[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?
+      end
+
+    end
+  end
+end

data/lib/genderize/io/parser/header.rb

@@ -0,0 +1,59 @@
+# frozen_string_literal: true
+
+module Genderize
+  module Io
+    module Parser
+      class Header
+
+        attr_reader :headers, :response, :strict
+
+        def initialize(response, strict: true)
+          @response = response
+          @strict = strict
+          @headers = []
+        end
+
+        def self.parse(response, strict: true)
+          klass = new(response, strict: strict)
+          klass.parse
+          klass
+        end
+
+        def parse
+          @headers = @response.split(/\\r\\n|\n|\r/)
+        end
+
+        def method_missing(sym, *_args)
+          detect_multi_value_keys(sym)
+        end
+
+        def response_code
+          @headers[0].match(/HTTP\/\d\.\d (\d{3}.*)/)[1]
+        end
+
+        def version
+          @headers[0].match(/HTTP\/\d\.\d/)[0]
+        end
+
+        private
+
+        def detect_multi_value_keys(tag)
+          tag = method_sym_to_http_pattern(tag)
+          results = @headers.select { |val| val =~ /^#{tag}:/i }.map { |val| value_from(val) }
+          results.size <= 1 ? results.first : results
+        end
+
+        def method_sym_to_http_pattern(sym)
+          replacement = @strict ? '-' : '[-_]'
+          sym.to_s.gsub('_', replacement)
+        end
+
+        def value_from(tag)
+          val = tag.split(/:\s+/)[1]
+          val =~ /^\"(.*)\"$/ ? $1 : val
+        end
+
+      end
+    end
+  end
+end

data/lib/genderize/io/parser/json.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+require 'json'
+
+module Genderize
+  module Io
+    module Parser
+      class Json
+
+        attr_reader :hash
+
+        def initialize(data)
+          @data = data
+          @hash = {}
+        end
+
+        def self.parse(data)
+          klass = new(data)
+          klass.parse
+          klass.hash
+        end
+
+        def parse
+          @hash = JSON.parse(@data)
+        end
+
+      end
+    end
+  end
+end

data/lib/genderize/io/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Genderize
+  module Io
+    VERSION ||= '0.1.0'
+  end
+end

metadata

@@ -0,0 +1,177 @@
+--- !ruby/object:Gem::Specification
+name: genderize-io
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Juan Gomez
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-11-28 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: typhoeus
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: user_agent_db
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  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: rake
+  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: rspec
+  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: fasterer
+  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: reek
+  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: rubocop
+  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: Genderize.io Ruby SDK for interacting with the Genderize.io API.
+email:
+- j.gomez@drexed.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".fasterer.yml"
+- ".gitignore"
+- ".reek"
+- ".rspec"
+- ".rubocop.yml"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- README.md
+- Rakefile
+- _config.yml
+- bin/console
+- bin/rake
+- bin/setup
+- genderize-io.gemspec
+- lib/genderize/io.rb
+- lib/genderize/io/lookup.rb
+- lib/genderize/io/parser/header.rb
+- lib/genderize/io/parser/json.rb
+- lib/genderize/io/version.rb
+homepage: http://drexed.github.io/genderize-io
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+- support
+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.7.2
+signing_key: 
+specification_version: 4
+summary: Genderize.io Ruby SDK.
+test_files: []