ruser 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 66d6e7ac951762522daa3c1555b480fa0467c5e7
+  data.tar.gz: d079425789e9f7797009c984d49f552adb4ffd82
+SHA512:
+  metadata.gz: 549a23b7444b88a3d390ad6e0a973a8510368bb62b0099392dae9f23dde199a3f866aae95fca0b9da41b28c0292a473ef2b4801aed06fc2955c4883e5d00a3a0
+  data.tar.gz: bb792c050ef150617928fdc8047df9238793b9c0971b7cef9733680b77ab15024fb8e7bf61a7c8204b27ffb6bf59a2623217256b8fba6d94b1683473cde7b59e

data/LICENSE

@@ -0,0 +1,9 @@
+The MIT License (MIT)
+
+Copyright © 2014 Simple App Group LLC <info@simpleappgroup.com>
+
+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,86 @@
+# RUser
+
+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)
+
+
+## Installation
+
+First:
+
+    gem install ruser
+
+or in your Gemfile
+
+    gem 'ruser'
+
+
+## Usage
+
+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}!"
+
+Then you can access any of the following user attributes:
+
+- gender
+- name
+ - first\_name
+ - last\_name
+ - title
+- location
+ - street
+ - city
+ - state
+ - zip
+- email
+- username
+- password
+- salt
+- md5
+- sha1
+- sha256
+- registered
+- dob
+- phone
+- cell
+- ssn
+- picture
+- seed
+
+If you want to request a male or female user specifically, call either the `.man` or `.woman` methods like so:
+
+    require 'ruser'
+	
+	ruser = RUser::Person.new
+	man = ruser.man
+
+	woman = ruser.woman
+
+If you want to request a specific user by their seed, simply call the `.lookup` method:
+
+    require 'ruser'
+	
+	ruser = RUser::Person.new
+	alberto = ruser.lookup('lazyWolf')
+
+## Contributing & Development
+
+    $ git clone https://github.com/simpleappgroup/ruser && cd ruser
+    $ bundle install
+
+* Fork the project.
+* Make your feature addition or bug fix. All specs should pass.
+* Add specs for your changes. This is important so I don't break it in a future version unintentionally.
+* Commit, do not mess with version, or history. If you want to have your own version, that is fine but bump version in a commit by itself in another branch so a maintainer ignore it when your pull request is merged.
+* Send a pull request. Bonus points for topic branches.
+
+## License & Copyright
+
+See LICENSE for details.

data/lib/ruser/api.rb

@@ -0,0 +1,6 @@
+module RUser
+  module Api
+    Url     = 'http://api.randomuser.me'
+    Version = '0.3.2'
+  end
+end

data/lib/ruser/person.rb

@@ -0,0 +1,65 @@
+require 'rest_client'
+require 'multi_json'
+require 'hashie'
+
+module RUser
+  class Person
+
+    def initialize
+      self
+    end
+
+    def random
+      self.fetch
+    end
+
+    def man
+      options = { "gender" => "male" }
+      self.fetch(options)
+    end
+
+    def woman
+      options = { "gender" => "female" }
+      self.fetch(options)
+    end
+
+    def lookup(seed = "")
+      options = { "seed" => seed }
+      self.fetch(options)
+    end
+
+    def fetch(options = {})
+      params = options.map { |k,v| "#{k}=#{v}" }
+      data = Hashie::Mash.new(MultiJson.load(RestClient.get [
+        RUser::Api::Url,
+        RUser::Api::Version,
+        "?" + 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,
+      })
+    end
+
+  end
+end

data/lib/ruser/version.rb

@@ -0,0 +1,3 @@
+module RUser
+  Version = '0.0.1'
+end

data/lib/ruser.rb

@@ -0,0 +1,5 @@
+module RUser
+  autoload :Version,  'ruser/version'
+  autoload :Api,      'ruser/api'
+  autoload :Person,   'ruser/person'
+end

data/spec/functional/person_spec.rb

@@ -0,0 +1,57 @@
+require 'ruser'
+require 'spec_helper'
+
+describe 'Person' do
+  before do
+    @person = RUser::Person.new
+  end
+
+  describe '.man' do
+    before do
+      @man = @person.man
+    end
+
+    it 'should return a male user' do
+      expect(@man.gender).to eql('male')
+    end
+  end
+
+  describe '.woman' do
+    before do
+      @woman = @person.woman
+    end
+
+    it 'should return a female user' do
+      expect(@woman.gender).to eql('female')
+    end
+  end
+
+  describe '.random' do
+    before do
+      @user = @person.random
+    end
+
+    it 'should return a gendered user' do
+      expect(@user.gender).to be_instance_of(String)
+    end
+  end
+
+  describe '.lookup' do
+    before do
+     @user = @person.lookup('lazyWolf') 
+    end
+
+    it 'should have the first name alberto' do
+      expect(@user.name.first_name).to eql('alberto')
+    end
+
+    it 'should have the last name holland' do
+      expect(@user.name.last_name).to eql('holland')
+    end
+
+    it 'should return a male user' do
+      expect(@user.gender).to eql('male')
+    end
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,10 @@
+require 'rubygems'
+require 'simplecov'
+require 'coveralls'
+
+SimpleCov.start
+Coveralls.wear!
+
+RSpec.configure do |config|
+  config.order = "random"
+end

metadata

@@ -0,0 +1,51 @@
+--- !ruby/object:Gem::Specification
+name: ruser
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Josh Kendall
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-03-26 00:00:00.000000000 Z
+dependencies: []
+description: A gem to interact with the randomuser.me API.
+email: josh@simpleappgroup.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- lib/ruser.rb
+- lib/ruser/api.rb
+- lib/ruser/person.rb
+- lib/ruser/version.rb
+- spec/functional/person_spec.rb
+- spec/spec_helper.rb
+homepage: http://github.com/simpleappgroup/ruser
+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.2.2
+signing_key: 
+specification_version: 4
+summary: Random User Generator API
+test_files: []