ruser 0.0.1.1 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 19ef0c18729d1fc11704ee82b256d2303b409590
-  data.tar.gz: 100fe995a45b724deabc344885afbb76639288f0
+  metadata.gz: 43a09f150d33f23b3afc41a2d279ce186bc9e99e
+  data.tar.gz: da507723153984d0981079707c2ae46fd49fb449
 SHA512:
-  metadata.gz: 9a5de14b762e77aef82bb23237558de11f31ee59bc3274f3870c26f412ee28d22c816ef1748ba19f5d086ecb970670b35e66328795e85bcb5f83ae2a730045e5
-  data.tar.gz: b1476127383fff69bd97cb829cd6cba9026f29951d632c0f7807e109ded14615936d6cf8829de3d46edea6bb26a9cdfc9c228762f327e44de62d522ad5752eaa
+  metadata.gz: eb8ae5407bc1a926feebcaab64968d92c7e8bbe618c34a1586afec84596ec3e418261da8f61970fa492afd1ba5b86f38215eda6022d8a92526e66663757563eb
+  data.tar.gz: acacf827c86755890d62e4fc0005e6b455df1735121cdd88fbc79db4ee71fc9ca3d9682338b834c59380168eebf22cfd4baccea2e21209cf1bc4fcc413eab74d

data/README.md

@@ -2,13 +2,11 @@
 
 RUser is a simple Ruby Gem to communicate with the randomuser.me API.
 
-[![Build Status](https://travis-ci.org/simpleappgroup/ruser.png)](https://travis-ci.org/simpleappgroup/ruser) [![Coverage Status](https://coveralls.io/repos/simpleappgroup/ruser/badge.png?branch=master)](https://coveralls.io/r/simpleappgroup/ruser?branch=master) [![Code Climate](https://codeclimate.com/github/simpleappgroup/ruser.png)](https://codeclimate.com/github/simpleappgroup/ruser)
+[![Build Status](https://travis-ci.org/simpleappgroup/ruser.png)](https://travis-ci.org/simpleappgroup/ruser) [![Coverage Status](https://coveralls.io/repos/simpleappgroup/ruser/badge.png?branch=master)](https://coveralls.io/r/simpleappgroup/ruser?branch=master) [![Code Climate](https://codeclimate.com/github/simpleappgroup/ruser.png)](https://codeclimate.com/github/simpleappgroup/ruser) [![Dependency Status](https://gemnasium.com/simpleappgroup/ruser.svg)](https://gemnasium.com/simpleappgroup/ruser)
 
 
 ## Installation
 
-First:
-
     gem install ruser
 
 or in your Gemfile
@@ -16,16 +14,19 @@ or in your Gemfile
     gem 'ruser'
 
 
-## Usage
+## Documentation
+
+[rdoc.info/github/simpleappgroup/ruser](http://rdoc.info/github/simpleappgroup/ruser)
+
+## Quickstart
 
 Using RUser in it's simplest form is as easy as calling:
 
     require 'ruser'
 	
 	ruser = RUser::Person.new
-	user = ruser.random
 
-	puts "This user is a #{user.gender}!"
+	puts "This user is a #{user.gender} named #{user.name.first_name}!"
 
 Then you can access any of the following user attributes:
 
@@ -54,21 +55,19 @@ Then you can access any of the following user attributes:
 - picture
 - seed
 
-If you want to request a male or female user specifically, call either the `.man` or `.woman` methods like so:
+If you want to request a female or male user specifically, specify the `:gender` key in the options hash passed to `new`:
 
     require 'ruser'
 	
-	ruser = RUser::Person.new
-	man = ruser.man
+	woman = RUser::Person.new({:gender => 'female'})
 
-	woman = ruser.woman
+	man = RUser::Person.new({:gender => 'male'})
 
-If you want to request a specific user by their seed, simply call the `.lookup` method:
+If you want to request a specific user by their seed, specify the `:seed` key in the options hash passed to `new`:
 
     require 'ruser'
 	
-	ruser = RUser::Person.new
-	alberto = ruser.lookup('lazyWolf')
+	lazyWolf = RUser::Person.new({:seed => 'lazyWolf'})
 
 ## Contributing & Development
 

data/lib/ruser/api.rb

@@ -1,6 +1,11 @@
 module RUser
+  # This module defines the RandomUser.me API constants used by classes.
+  # @author Simple App Group, LLC.
   module Api
-    Url     = 'http://api.randomuser.me'
+    # The URL for the API.
+    Url = 'http://api.randomuser.me'
+
+    # The version of the API that is used.
     Version = '0.3.2'
   end
 end

data/lib/ruser/person.rb

@@ -3,32 +3,78 @@ require 'multi_json'
 require 'hashie'
 
 module RUser
+  # This class allows the creation of new users from the RandomUser.me API.
+  # @author Simple App Group, LLC.
   class Person
 
-    def initialize
-      self
-    end
+    # @return [String] the user's gender, either male or female.
+    attr_reader :gender
 
-    def random
-      self.fetch
-    end
+    # @return [Hash] the user's location including containing the :street, :city, :state, and :zip.
+    attr_reader :location
 
-    def man
-      options = { "gender" => "male" }
-      self.fetch(options)
-    end
+    # @return [Hash] the user's name including :title (Mr, Mrs, etc.), :first_name, and :last_name.
+    attr_reader :name
 
-    def woman
-      options = { "gender" => "female" }
-      self.fetch(options)
-    end
+    # @return [String] the user's email address.
+    attr_reader :email
 
-    def lookup(seed = "")
-      options = { "seed" => seed }
-      self.fetch(options)
-    end
+    # @return [String] the user's username.
+    attr_reader :username
+
+    # @return [String] the user's password.
+    attr_reader :password
+
+    # @return [String] the user's password salt.
+    attr_reader :salt
+
+    # @return [String] the md5 hash of the user's salted password.
+    attr_reader :md5
+
+    # @return [String] the sha1 hash of the user's salted password.
+    attr_reader :sha1
+
+    # @return [String] the sha256 hash of the user's salted password.
+    attr_reader :sha256
+
+    # @return [String] the date of the user's registration.
+    attr_reader :registered
+
+    # @return [String] the user's date of birth.
+    attr_reader :dob
+
+    # @return [String] the user's phone number.
+    attr_reader :phone
+
+    # @return [String] the user's cell phone number.
+    attr_reader :cell
+
+    # @return [String] the user's social security number.
+    attr_reader :ssn
+
+    # @return [String] the user's profile picture url.
+    attr_reader :picture
+
+    # @return [String] the user's unique seed which allows future calls for the same user.
+    attr_reader :seed
 
-    def fetch(options = {})
+    # Creates a new person object
+    #
+    # @param [Hash] options a set of options to pass to the template
+    #
+    # @option options [String] :gender (nil) the user's gender
+    # @option options [String] :seed (nil) the user's unique seed value
+    #
+    # @example Create a random user
+    #   Person.new()
+    # @example Create a male user
+    #   Person.new({:gender => 'male'})
+    # @example Create a female user
+    #   Person.new({:gender => 'female'})
+    # @example Create a specific user from a seed
+    #   Person.new({:seed => 'lazyWolf'})
+    # @return [Person]
+    def initialize(options = {})
       params = options.map { |k,v| "#{k}=#{v}" }
       data = Hashie::Mash.new(MultiJson.load(RestClient.get [
         RUser::Api::Url,
@@ -36,29 +82,27 @@ module RUser
         "?" + params.join('&')
       ].join('/'))['results'][0])
 
-      Hashie::Mash.new({
-        "gender"      => data.user.gender,
-        "location"    => data.user.location,
-        "name"        => {
-          "title"       => data.user.name.title,
-          "first_name"  => data.user.name['first'],
-          "last_name"   => data.user.name['last'],
-        },
-        "email"       => data.user.email,
-        "username"    => data.user.username,
-        "password"    => data.user.password,
-        "salt"        => data.user.salt,
-        "md5"         => data.user.md5,
-        "sha1"        => data.user.sha1,
-        "sha256"      => data.user.sha256,
-        "registered"  => data.user.registered,
-        "dob"         => data.user.dob,
-        "phone"       => data.user.phone,
-        "cell"        => data.user.cell,
-        "ssn"         => data.user.SSN,
-        "picture"     => data.user.picture,
-        "seed"        => data.seed,
+      @gender      = data.user.gender
+      @location    = data.user.location
+      @name        = Hashie::Mash.new({
+        "title"       => data.user.name.title,
+        "first_name"  => data.user.name['first'],
+        "last_name"   => data.user.name['last']
       })
+      @email       = data.user.email
+      @username    = data.user.username
+      @password    = data.user.password
+      @salt        = data.user.salt
+      @md5         = data.user.md5
+      @sha1        = data.user.sha1
+      @sha256      = data.user.sha256
+      @registered  = data.user.registered
+      @dob         = data.user.dob
+      @phone       = data.user.phone
+      @cell        = data.user.cell
+      @ssn         = data.user.SSN
+      @picture     = data.user.picture
+      @seed        = data.seed
     end
 
   end

data/lib/ruser/version.rb

@@ -1,3 +1,3 @@
 module RUser
-  Version = '0.0.1.1'
+  Version = '1.0.0'
 end

data/spec/functional/person_spec.rb

@@ -2,13 +2,10 @@ require 'ruser'
 require 'spec_helper'
 
 describe 'Person' do
-  before do
-    @person = RUser::Person.new
-  end
 
   describe '.man' do
     before do
-      @man = @person.man
+      @man = RUser::Person.new(gender: 'male')
     end
 
     it 'should return a male user' do
@@ -18,7 +15,7 @@ describe 'Person' do
 
   describe '.woman' do
     before do
-      @woman = @person.woman
+      @woman = RUser::Person.new(gender: 'female')
     end
 
     it 'should return a female user' do
@@ -28,7 +25,7 @@ describe 'Person' do
 
   describe '.random' do
     before do
-      @user = @person.random
+      @user = RUser::Person.new()
     end
 
     it 'should return a gendered user' do
@@ -38,7 +35,7 @@ describe 'Person' do
 
   describe '.lookup' do
     before do
-     @user = @person.lookup('lazyWolf') 
+     @user = RUser::Person.new(seed: 'lazyWolf')
     end
 
     it 'should have the first name alberto' do

metadata

@@ -1,73 +1,73 @@
 --- !ruby/object:Gem::Specification
 name: ruser
 version: !ruby/object:Gem::Version
-  version: 0.0.1.1
+  version: 1.0.0
 platform: ruby
 authors:
 - Josh Kendall
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-03-26 00:00:00.000000000 Z
+date: 2014-04-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: multi_json
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.9'
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 1.9.2
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.9'
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 1.9.2
 - !ruby/object:Gem::Dependency
   name: hashie
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '2.0'
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 2.0.5
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '2.0'
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 2.0.5
 - !ruby/object:Gem::Dependency
   name: rest-client
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.6'
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 1.6.7
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.6'
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 1.6.7
 description: A gem to interact with the randomuser.me API.
@@ -94,18 +94,19 @@ 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.2.2
+rubygems_version: 2.2.0
 signing_key: 
 specification_version: 4
 summary: Random User Generator API
 test_files: []
+has_rdoc: