randomuser 0.0.1 → 0.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2f629a1ae617982207be3f267b7b28676db37395
-  data.tar.gz: dd1dc063fbfbfd0e6490c85fd3c7f04675c410f6
+  metadata.gz: 585ecd0aaefd548222f03514ba40642134be774f
+  data.tar.gz: c21db409a7bfa3c85e86c83a88181037220b9a0e
 SHA512:
-  metadata.gz: 40f9509653a12a3daf989a64c85456e6f8815154e87636d62a004a712920938e07bd8e3204b5e61f2426ebda092fb630ecd2bebba20cd914d891e2c4b6eb5028
-  data.tar.gz: ad8e5d44226d4f6c675858d00192949cb3322159416af3e61c5c03b7321ca7e88f6a0c90849968bcc0a5293537df3e4efa729231b61413ac75c432e9f0b7a8e1
+  metadata.gz: d6bd853433cad2ac3c5222828e5ca52e2abaa122d2be9a411a353f30ade08d84825ae595cda80da8eee0b7a87bb3c8a727d03672c9f4d08e62e0daa933ce236a
+  data.tar.gz: 06d1fb3049bf97636099ee7e729aed693246f01a548e81a265e6ed5cd16e2ce65a3fbf823add9629286bb1d4e938f06e03ce6cb1cc6cfccb00f55d4d7198e481

data/README.md

@@ -6,49 +6,78 @@ This gem returns simple JSON/hash responses from the [Random User Generator](htt
 
 Add this line to your application's Gemfile:
 
-    gem 'randomuser'
+```ruby
+gem 'randomuser'
+```
 
 And then execute:
 
-    $ bundle
+```bash
+$ bundle
+```
 
-Or install it yourself as:
+Or install it as a standalone gem with:
 
-    $ gem install randomuser
+```bash
+$ gem install randomuser
+```
 
 ## Usage
 
 To request a single random user:
 
-```
+```ruby
 Randomuser.generate
 ```
 
 To request multiple random users:
 
-```
-Randomuser.generate('results=5')
+```ruby
+Randomuser.generate(5)
 ```
 
-To request a specific gender:
+To request a single female random user:
 
+```ruby
+Randomuser.generate_female
 ```
-Randomuser.generate('gender=female')
+
+To request multiple female random users:
+
+```ruby
+Randomuser.generate_female(5)
 ```
 
-To request a specific gender with multiple results:
+To request a single male random user:
 
+```ruby
+Randomuser.generate_male
 ```
-Randomuser.generate('results=5&gender=female')
+
+To request multiple male random users:
+
+```ruby
+Randomuser.generate_male(5)
 ```
 
 To request a specific user:
 
+```ruby
+Randomuser.generate_seed('foobar')
 ```
-Randomuser.generate('seed=smallPanda')
-```
 
-For more information on how to customize requests, please see the [Random User Generator](http://randomuser.me) site.
+For more information on this API, please see the [Random User Generator](http://randomuser.me) site.
+
+## Tests
+
+Testing works as usual:
+
+```bash
+git clone https://github.com/humanshell/randomuser.git
+cd randomuser
+bundle install
+rake
+```
 
 ## Contributing
 

data/Rakefile

@@ -4,15 +4,14 @@ require 'rake/testtask'
 desc 'Generate gem documentation'
 task :doc do
   system 'rm -rf doc/'
-  system 'rdoc --exclude=/spec/'
+  system 'rdoc --exclude=/test/'
 end
 
 namespace :minitest do
   Rake::TestTask.new(:all) do |t|
-    t.libs << 'spec'
-    t.test_files = FileList['spec/*_spec.rb']
+    t.libs << 'test'
+    t.test_files = FileList['test/*_test.rb']
   end
 end
 
 task :default => 'minitest:all'
-

data/lib/randomuser.rb

@@ -1,29 +1,41 @@
-# Randomuser Ruby Library
 require 'net/http'
 require 'uri'
 require 'json'
 require 'randomuser/version'
 
 module Randomuser
-  @@api_base = 'http://randomuser.me/g/'
 
-  def self.api_url(query='')
-    "#{@@api_base}?#{query}"
+  def self.generate(number=1)
+    request("results=#{number}")
   end
 
-  def self.generate(query='')
+  def self.generate_female(number=1)
+    request("results=#{number}&gender=female")
+  end
 
-    # create the http connection object
-    uri  = URI.parse(self.api_url(query))
-    http = Net::HTTP.new(uri.host, uri.port)
+  def self.generate_male(number=1)
+    request("results=#{number}&gender=male")
+  end
 
-    # open our HTTP connection and send the appropriate request type
-    # the block will automatically close our connection so we don't have to
-    http.start do |connection|
-      response = connection.send_request(:get, uri.request_uri)
-      response = JSON.parse(response.body, symbolize_names: true)
-      response[:results]
-    end
-    
+  def self.generate_seed(seed='')
+    request("seed=#{seed}")
   end
+
+  private
+
+    def self.api_url(query='')
+      "http://api.randomuser.me/#{Randomuser::VERSION}/?#{query}"
+    end
+  
+    def self.request(query='')
+      uri  = URI.parse(self.api_url(query))
+      http = Net::HTTP.new(uri.host, uri.port)
+
+      http.start do |connection|
+        response = connection.send_request(:get, uri.request_uri)
+        response = JSON.parse(response.body, symbolize_names: true)
+        response[:results]
+      end
+    end
+
 end

data/lib/randomuser/version.rb

@@ -1,3 +1,3 @@
 module Randomuser
-  VERSION = '0.0.1'
+  VERSION = '0.3.1'
 end

data/test/all_test.rb

@@ -0,0 +1,62 @@
+# coding: utf-8
+require 'test_helper'
+
+# all tests for randomuser api gem
+
+class TestRandomuser < Minitest::Test
+
+  def test_generate_returns_single_response
+    response = Randomuser.generate
+    assert_equal(response.class, Array)
+    assert_equal(response.length, 1)
+  end
+
+  def test_generate_returns_multiple_responses
+    response = Randomuser.generate(5)
+    assert_equal(response.class, Array)
+    assert_equal(response.length, 5)
+  end
+
+  def test_generate_female_returns_single_response
+    response = Randomuser.generate_female
+    assert_equal(response.class, Array)
+    assert_equal(response.length, 1)
+    assert_equal(response.first[:user][:gender], 'female')
+    assert_equal(response.first[:user][:name][:title], 'mrs')
+    assert_equal(response.first[:user][:picture], 'http://api.randomuser.me/0.3.1/portraits/women/0.jpg')
+  end
+
+  def test_generate_female_returns_multiple_responses
+    response = Randomuser.generate_female(5)
+    assert_equal(response.class, Array)
+    assert_equal(response.length, 5)
+    assert_equal(response.first[:user][:gender], 'female')
+    assert_equal(response.first[:user][:name][:title], 'mrs')
+    assert_equal(response.first[:user][:picture], 'http://api.randomuser.me/0.3.1/portraits/women/0.jpg')
+  end
+
+  def test_generate_male_returns_single_response
+    response = Randomuser.generate_male
+    assert_equal(response.class, Array)
+    assert_equal(response.length, 1)
+    assert_equal(response.first[:user][:gender], 'male')
+    assert_equal(response.first[:user][:name][:title], 'mr')
+    assert_equal(response.first[:user][:picture], 'http://api.randomuser.me/0.3.1/portraits/men/0.jpg')
+  end
+
+  def test_generate_male_returns_multiple_responses
+    response = Randomuser.generate_male(5)
+    assert_equal(response.class, Array)
+    assert_equal(response.length, 5)
+    assert_equal(response.first[:user][:gender], 'male')
+    assert_equal(response.first[:user][:name][:title], 'mr')
+    assert_equal(response.first[:user][:picture], 'http://api.randomuser.me/0.3.1/portraits/men/0.jpg')
+  end
+
+  def test_generate_seed_returns_single_response
+    response = Randomuser.generate_seed
+    assert_equal(response.class, Array)
+    assert_equal(response.length, 1)
+  end
+
+end

data/test/test_helper.rb

@@ -0,0 +1,59 @@
+# coding: utf-8
+# use minitest gem, not the one from stdlib
+gem     'minitest'
+
+require 'minitest/autorun'
+require 'randomuser'
+
+# override the generate methods so they return mock responses during testing
+module Randomuser
+  def self.generate(number=1)
+    Array.new(number, mock_response)
+  end
+
+  def self.generate_female(number=1)
+    Array.new(number, mock_response)
+  end
+
+  def self.generate_male(number=1)
+    Array.new(number, mock_response('male'))
+  end
+
+  def self.generate_seed(seed='')
+    Array.new(1, mock_response)
+  end
+end
+
+def mock_response(gender='female')
+  {
+    user: {
+      gender: "#{gender == 'female' ? 'female' : 'male'}",
+      name: {
+        title: "#{gender == 'female' ? 'mrs' : 'mr'}",
+        first: "first",
+        last: "last"
+      },
+      location: {
+        street: "6127 pine dr",
+        city: "raleigh",
+        state: "colorado",
+        zip: "34545"
+      },
+      email: "first.last@example.com",
+      username: "blueleopard186",
+      password: "password",
+      salt: "L",
+      md5: "003b0f6e9b1b40200ba0370a5f29208e",
+      sha1: "87b7b6b2a06238c0bb7174f03f74ae86211afc7d",
+      sha256: "49995e8aadf97fa0cca079be5bbf47b5fa0c5ffb0dd81831ee9b382c9772b46b",
+      registered: "1134630377",
+      dob: "326899532",
+      phone: "(164)-244-7352",
+      cell: "(485)-899-1991",
+      SSN: "525-20-3862",
+      picture: "http://api.randomuser.me/0.3.1/portraits/#{gender == 'female' ? 'women' : 'men'}/0.jpg"
+    },
+    seed: "beautifulLeopard",
+    version: "0.3.1"
+  }
+end

metadata

@@ -1,55 +1,55 @@
 --- !ruby/object:Gem::Specification
 name: randomuser
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.3.1
 platform: ruby
 authors:
 - Dominic Giglio
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-09-03 00:00:00.000000000 Z
+date: 2014-02-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: minitest
   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: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.3'
 - !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'
 description: This gem returns simple JSON/hash responses from the Random User Generator
@@ -61,7 +61,7 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
+- ".gitignore"
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -70,6 +70,8 @@ files:
 - lib/randomuser.rb
 - lib/randomuser/version.rb
 - randomuser.gemspec
+- test/all_test.rb
+- test/test_helper.rb
 homepage: http://developr.me
 licenses:
 - MIT
@@ -80,18 +82,21 @@ 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.0.3
+rubygems_version: 2.0.14
 signing_key: 
 specification_version: 4
 summary: Access Random User Generator API
-test_files: []
+test_files:
+- test/all_test.rb
+- test/test_helper.rb
+has_rdoc: