random_user_generator 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: abf1401c0379d3a33a0a02d3401ef6e780fed463
+  data.tar.gz: 1aef4068929e0da904d9f68164efff51171f5973
+SHA512:
+  metadata.gz: 9ae06f5663c9076469718cfafa700a7d4c43cac2c4501376fab84e422f9f3e7578b0821ddb12ddec66932ace3a8f19df38c9c8873522b37cb57002086544828e
+  data.tar.gz: c9b650e8db9874d0785aec7ab7fb65d18309907fac07389de439827b330a787d70295813fa5341000ead13c7cfe3ef0c69d11d89fb64afce83c3d00f53b4bdea

data/.gitignore

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

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,3 @@
+language: ruby
+rvm:
+  - 2.2.2

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,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in random_user_generator.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Samnang Chhun
+
+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,62 @@
+# Random User Generator
+
+A Ruby wrapper for RandomUser API. See <https://randomuser.me>
+
+API information can be found at <https://randomuser.me/documentation>
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'random_user_generator'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install random_user_generator
+
+## Usage
+
+```ruby
+# Generate a random user
+user = RandomUserGenerator.generate
+user.email
+user.name.first
+
+# Generate multiple random users
+users = RandomUserGenerator.generate(results: 2)
+
+# Generate a random female/male user
+female_user = RandomUserGenerator.generate_female
+male_user   = RandomUserGenerator.generate_male
+
+# Generate random users base on global options
+RandomUserGenerator.configure do |config|
+  config.gender = 'female'
+end
+female_user = RandomUserGenerator.generate
+male_user   = RandomUserGenerator.generate(gender: 'male') # overridden by inline
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `bin/console` for an interactive prompt that will allow you to experiment.
+
+## Contributing
+
+1. Fork it ( https://github.com/samnang/random_user_generator/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request
+
+## Copyright
+Copyright (c) 2015 Samnang Chhun.
+See [LICENSE][] for details.
+
+[license]: LICENSE.txt

data/Rakefile

@@ -0,0 +1,6 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new('spec')
+
+task default: :spec

data/bin/console

@@ -0,0 +1,10 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "random_user_generator"
+
+# 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.
+
+require "pry"
+Pry.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/random_user_generator/client.rb

@@ -0,0 +1,25 @@
+module RandomUserGenerator
+  class Client
+    HOST = 'http://api.randomuser.me'
+
+    def request(params)
+      response = connection.get(api_url, params)
+      response.body['results'].map { |u| u['user'] }
+    end
+
+    private
+
+    def connection
+      Faraday.new(HOST, params: RandomUserGenerator.options) do |faraday|
+        faraday.response :json, content_type: /\bjson$/
+
+        faraday.use     FaradayMiddleware::FollowRedirects
+        faraday.adapter Faraday.default_adapter
+      end
+    end
+
+    def api_url
+      "/#{RandomUserGenerator.api_version}"
+    end
+  end
+end

data/lib/random_user_generator/configuration.rb

@@ -0,0 +1,26 @@
+module RandomUserGenerator
+  module Configuration
+    OPTIONS = [:key, :nat, :gender, :seed]
+
+    attr_accessor :api_version
+    attr_accessor *OPTIONS
+
+    def configure
+      yield self
+    end
+
+    def options
+      OPTIONS.inject({}) do |option, key|
+        option.merge!(key => send(key))
+      end
+    end
+
+    def reset
+      self.api_version = nil
+      self.key         = nil
+      self.nat         = nil
+      self.gender      = nil
+      self.seed        = nil
+    end
+  end
+end

data/lib/random_user_generator/version.rb

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

data/lib/random_user_generator.rb

@@ -0,0 +1,35 @@
+require "json"
+require "ostruct"
+
+require "faraday"
+require 'faraday_middleware'
+
+require "random_user_generator/configuration"
+require "random_user_generator/client"
+
+require "random_user_generator/version"
+
+module RandomUserGenerator
+  extend Configuration
+
+  def self.generate(params = {})
+    results = client.request(params)
+    users   = JSON.parse(results.to_json, object_class: OpenStruct)
+
+    params[:results] ? users : users.first
+  end
+
+  def self.generate_female(params = {})
+    params.merge!(gender: 'female')
+    generate(params)
+  end
+
+  def self.generate_male(params = {})
+    params.merge!(gender: 'male')
+    generate(params)
+  end
+
+  def self.client
+    @client ||= Client.new
+  end
+end

data/random_user_generator.gemspec

@@ -0,0 +1,29 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'random_user_generator/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "random_user_generator"
+  spec.version       = RandomUserGenerator::VERSION
+  spec.authors       = ["Samnang Chhun"]
+  spec.email         = ["samnang.chhun@gmail.com"]
+
+  spec.summary       = %q{Ruby wrapper for the RandomUser API.}
+  spec.description   = %q{A Ruby wrapper for the RandomUser API.}
+  spec.homepage      = "https://github.com/samnang/random_user_generator"
+  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 = ["lib"]
+
+  spec.add_dependency "faraday", "~> 0.9.0"
+  spec.add_dependency "faraday_middleware", "~> 0.9.0"
+
+  spec.add_development_dependency "bundler", "~> 1.9"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.2.0"
+  spec.add_development_dependency "pry", "~> 0.10.0"
+end

metadata

@@ -0,0 +1,143 @@
+--- !ruby/object:Gem::Specification
+name: random_user_generator
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Samnang Chhun
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-05-26 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.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.0
+- !ruby/object:Gem::Dependency
+  name: faraday_middleware
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.0
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.9'
+- !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.2.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.2.0
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.10.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.10.0
+description: A Ruby wrapper for the RandomUser API.
+email:
+- samnang.chhun@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/random_user_generator.rb
+- lib/random_user_generator/client.rb
+- lib/random_user_generator/configuration.rb
+- lib/random_user_generator/version.rb
+- random_user_generator.gemspec
+homepage: https://github.com/samnang/random_user_generator
+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
+signing_key: 
+specification_version: 4
+summary: Ruby wrapper for the RandomUser API.
+test_files: []