random_api 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 4a074c715909f4eebca52ee9739ff7da2ae1437a
+  data.tar.gz: 34a296fff2efeb2bba8c1593e102ffb0fe5a32c5
+SHA512:
+  metadata.gz: 28e32619217dbf35207807defc4e3b1e14023fbb8eb6702c81dd765246b22d2dcbf8efc4980d664c495394b846ada3dc69d8e16e32c96379a7725c247372b508
+  data.tar.gz: 757cb3917e96b0d7fe84e4bd8b9f7d9b060f94c9ec538aa99bc511ab9e207f97fb517914536916cc39e0ad1d7827cc99241dad04bd3c245504b0118515872e5d

data/.gitignore

@@ -0,0 +1,16 @@
+
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log
+Gemfile.lock

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in random_api.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,22 @@
+The MIT License (MIT)
+
+Copyright (c) 2014 Brandon Buck
+
+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/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Brandon
+
+MIT License
+
+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 @@
+# RandomAPI
+
+Interface with the RandomAPI at https://randomuser.me and provide a ruby wrapper for the responses. Interact with response as a Ruby object with helper methods for fetching all important data.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'random_api'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install random_api
+
+## Usage
+
+Using RandomAPI is simple, you can use it anonymously or use your API Key to make requests.
+
+```ruby
+# Create a RandomAPI service with anonymous access to the API
+service = RandomApi::Service.new
+
+# Fetch a single random user
+user = service.user
+
+# Fetch a male user
+user = service.user(gender: "male")
+
+# Fetch a list of users
+user = service.users(10)
+
+# Fetch 10 male users
+user = service.users(10, gender: "male")
+
+# If you have an API Key, pass it to service
+service = RandomApi::Service.new(api_key)
+
+# Then make requests as per the norm
+```
+
+The object returned by the call to `RandomApi::Service#user` and `RandomApi::Service#users` is of the type `RandomApi::User`.
+
+```ruby
+user = service.user
+
+user.gender # => "female"
+user.name # => "Ms. Lois Williams"
+user.title # => "Ms."
+user.first_name # => "Lois"
+user.last_name # => "Williams"
+user.street # => "1969 Elgin St"
+user.city # => "Frederick"
+user.state # => "Delaware"
+user.zip # => "56298"
+user.email # => "lois.williams50@example.com"
+user.username # => "heavybutterfly920"
+user.password # => "enterprise"
+user.salt # => ">egEn6YsO"
+user.md5 # => "2dd1894ea9d19bf5479992da95713a3a",
+user.sha1 # => "ba230bc400723f470b68e9609ab7d0e6cf123b59",
+user.sha256 # => "f4f52bf8c5ad7fc759d1d4156b25a4c7b3d1e2eec6c92d80e508aa0b7946d4ba",
+user.registered # => "1288182167",
+user.dob # => "146582153",
+user.phone # => "(555)-942-1322",
+user.cell # => "(178)-341-1520",
+user.SSN # => "137-37-8866",
+user.large_picture # => "http://api.randomuser.me/portraits/women/55.jpg",
+user.medium_picture # => "http://api.randomuser.me/portraits/med/women/55.jpg",
+user.thumbnail # => "http://api.randomuser.me/portraits/thumb/women/55.jpg",
+user.api_version # => "0.4.1"
+user.seed # => "graywolf"
+```
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/random_api/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

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+
+begin
+  require "rspec/core/rake_task"
+  RSpec::Core::RakeTask.new(:spec) do |t|
+    t.rspec_opts = "--color --format documentation"
+  end
+rescue LoadError
+end
+

data/lib/random_api/invalid_user_data.rb

@@ -0,0 +1,2 @@
+class RandomApi::InvalidUserData < RuntimeError
+end

data/lib/random_api/service.rb

@@ -0,0 +1,68 @@
+require "httparty"
+
+require "random_api/user"
+
+class RandomApi::Service
+  include HTTParty
+
+  base_uri "api.randomuser.me/0.4.1"
+
+  def initialize(api_key = nil)
+    @api_key = api_key
+  end
+
+  def user(options = {})
+    options = options.dup
+    options.delete(:results) # Single user request, no need
+    options = {
+      query: default_query_options.merge(query_options_from(options))
+    }
+    RandomApi::User.new(self.class.get("/", options)["results"].first)
+  end
+
+  def users(count, options = {})
+    options = options.dup
+    options[:results] = count
+    options = {
+      query: default_query_options.merge(query_options_from(options))
+    }
+    results = self.class.get("/", options)["results"]
+    results.map { |data| RandomApi::User.new(data) }
+  end
+
+  def to_s
+    "RandomAPI Service " + (@api_key.nil? ? "no api key given" : @api_key)
+  end
+
+  def inspect
+    "#<RandomApi::Service " + (@api_key.nil? ? "anonymous" : "setup with key") + ">"
+  end
+
+  private
+
+  def query_options_from(options)
+    query = {}
+    valid_options.each do |key|
+      query[key] = options[key] if options.has_key?(key)
+    end
+    query
+  end
+
+  def valid_options
+    @_valid_options ||= [:results, :gender, :seed]
+  end
+
+  def default_query_options
+    query = {
+      results: 1
+    }
+    query[:key] = @api_key unless @api_key.nil?
+    query
+  end
+
+  def request_options
+    opts = {}
+    opts[:query] = {}
+    opts[:query][:key] = @api_key unless @api_key.nil?
+  end
+end

data/lib/random_api/user.rb

@@ -0,0 +1,63 @@
+require "random_api/invalid_user_data"
+
+class RandomApi::User
+  attr_accessor :gender, :title, :first_name, :last_name, :name, :street, :city,
+                :state, :zip, :email, :username, :password, :salt, :md5, :sha1,
+                :sha256, :registered, :dob, :phone, :cell, :ssn, :large_picture,
+                :medium_picture, :thumbnail, :api_version, :seed, :api_response
+
+  def initialize(user_obj)
+    begin
+      load_from_api_response(user_obj)
+    rescue Exception
+      raise RandomApi::InvalidUserData, "The user data given is not of the correct format to be parsed."
+    end
+  end
+
+  def to_s
+    name
+  end
+
+  def inspect
+    "#<RandomApi::User version=#{api_version} \"#{name}\">"
+  end
+
+  def to_s
+    name
+  end
+
+  def inspect
+    "#<RandomApi::User version=#{api_version} \"#{name}\">"
+  end
+
+  private
+
+  def load_from_api_response(user_obj)
+    self.api_response = user_obj
+    self.seed = user_obj["seed"]
+    user_data = user_obj["user"]
+    user_data.each do |key, value|
+      next if ["name", "dob", "registered"].include?(key)
+      key = key.to_s.downcase
+      if respond_to?("#{key}=", true)
+        send("#{key}=", value)
+      end
+    end
+    self.title = user_data["name"]["title"]
+    self.title += "." unless title == "miss"
+    self.title.capitalize!
+    self.first_name = user_data["name"]["first"].capitalize
+    self.last_name = user_data["name"]["last"].capitalize
+    self.name = "#{title} #{first_name} #{last_name}"
+    self.dob = DateTime.strptime(user_data["dob"], "%s").to_time
+    self.registered = DateTime.strptime(user_data["registered"], "%s").to_time
+    self.street = user_data["location"]["street"].split(" ").map(&:capitalize).join(" ")
+    self.city = user_data["location"]["city"].capitalize
+    self.state = user_data["location"]["state"].capitalize
+    self.zip = user_data["location"]["zip"]
+    self.large_picture = user_data["picture"]["large"]
+    self.medium_picture = user_data["picture"]["medium"]
+    self.thumbnail = user_data["picture"]["thumbnail"]
+    self.api_version = user_data["version"]
+  end
+end

data/lib/random_api/version.rb

@@ -0,0 +1,3 @@
+module RandomApi
+  VERSION = "0.0.1"
+end

data/lib/random_api.rb

@@ -0,0 +1,5 @@
+require "random_api/version"
+require "random_api/service"
+
+module RandomApi
+end

data/random_api.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'random_api/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "random_api"
+  spec.version       = RandomApi::VERSION
+  spec.authors       = ["Brandon"]
+  spec.email         = ["lordizuriel@gmail.com"]
+  spec.summary       = "Interface with the Random API https://randomuser.me"
+  spec.description   = "Provide a ruby interface for pulling data from the Random API, fetching random user data."
+  spec.homepage      = "https://github.com/bbuck/random_api"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_runtime_dependency "httparty", "~> 0.13.3"
+
+  spec.add_development_dependency "bundler", "~> 1.7"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.1"
+end

data/spec/random_api/service_spec.rb

@@ -0,0 +1,33 @@
+require "spec_helper"
+
+describe RandomApi::Service do
+  it { should respond_to(:user) }
+
+  describe "#user" do
+    let(:service) { RandomApi::Service.new }
+
+    it "should return a user" do
+      expect(service.user).to be_a(RandomApi::User)
+    end
+
+    it "should accept options" do
+      expect(service.user(gender: "female").gender).to eq("female")
+      expect(service.user(gender: "male").gender).to eq("male")
+    end
+  end
+
+  describe "#users" do
+    let(:service) { RandomApi::Service.new }
+
+    it "should return more than one user" do
+      expect(service.users(10).length).to eq(10)
+    end
+
+    it "should accept options" do
+      male = "male" * 10
+      female = "female" * 10
+      expect(service.users(10, gender: "male").map(&:gender).join).to eq(male)
+      expect(service.users(10, gender: "female").map(&:gender).join).to eq(female)
+    end
+  end
+end

data/spec/random_api/user_spec.rb

@@ -0,0 +1,47 @@
+require "spec_helper"
+
+describe RandomApi::User do
+  subject { RandomApi::User.new(stub_user_return) }
+  it { should respond_to(:gender, :title, :first_name, :last_name, :name,
+                         :street, :city, :state, :zip, :email, :username,
+                         :password, :salt, :md5, :sha1, :sha256, :registered,
+                         :dob, :phone, :cell, :ssn, :large_picture,
+                         :medium_picture, :thumbnail, :api_version, :seed,
+                         :api_response) }
+
+  describe "#initialize" do
+    describe "should load from api response" do
+      let(:user) { RandomApi::User.new(stub_user_return) }
+
+      it "should contain user data" do
+        expect(user.gender).to eq("female")
+        expect(user.name).to eq("Ms. Lois Williams")
+        expect(user.title).to eq("Ms.")
+        expect(user.first_name).to eq("Lois")
+        expect(user.last_name).to eq("Williams")
+        expect(user.street).to eq("1969 Elgin St")
+        expect(user.city).to eq("Frederick")
+        expect(user.state).to eq("Delaware")
+        expect(user.zip).to eq("56298")
+        expect(user.email).to eq("lois.williams50@example.com")
+        expect(user.username).to eq("heavybutterfly920")
+        expect(user.password).to eq("enterprise")
+        expect(user.salt).to eq(">egEn6YsO")
+        expect(user.md5).to eq("2dd1894ea9d19bf5479992da95713a3a")
+        expect(user.sha1).to eq("ba230bc400723f470b68e9609ab7d0e6cf123b59")
+        expect(user.sha256).to eq("f4f52bf8c5ad7fc759d1d4156b25a4c7b3d1e2eec6c92d80e508aa0b7946d4ba")
+        expect(user.registered.strftime("%s")).to eq("1288182167")
+        expect(user.dob.strftime("%s")).to eq("146582153")
+        expect(user.phone).to eq("(555)-942-1322")
+        expect(user.cell).to eq("(178)-341-1520")
+        expect(user.ssn).to eq("137-37-8866")
+        expect(user.large_picture).to eq("http://api.randomuser.me/portraits/women/55.jpg")
+        expect(user.medium_picture).to eq("http://api.randomuser.me/portraits/med/women/55.jpg")
+        expect(user.thumbnail).to eq("http://api.randomuser.me/portraits/thumb/women/55.jpg")
+        expect(user.api_version).to eq("0.4.1")
+        expect(user.seed).to eq("graywolf")
+        expect(user.api_response).to eq(stub_user_return)
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,39 @@
+require "random_api"
+
+def stub_user_return
+  {
+    "user" => {
+      "gender" => "female",
+      "name" => {
+        "title" => "ms",
+        "first" => "lois",
+        "last" => "williams"
+      },
+      "location" => {
+        "street" => "1969 elgin st",
+        "city" => "frederick",
+        "state" => "delaware",
+        "zip" => "56298"
+      },
+      "email" => "lois.williams50@example.com",
+      "username" => "heavybutterfly920",
+      "password" => "enterprise",
+      "salt" => ">egEn6YsO",
+      "md5" => "2dd1894ea9d19bf5479992da95713a3a",
+      "sha1" => "ba230bc400723f470b68e9609ab7d0e6cf123b59",
+      "sha256" => "f4f52bf8c5ad7fc759d1d4156b25a4c7b3d1e2eec6c92d80e508aa0b7946d4ba",
+      "registered" => "1288182167",
+      "dob" => "146582153",
+      "phone" => "(555)-942-1322",
+      "cell" => "(178)-341-1520",
+      "SSN" => "137-37-8866",
+      "picture" => {
+        "large" => "http://api.randomuser.me/portraits/women/55.jpg",
+        "medium" => "http://api.randomuser.me/portraits/med/women/55.jpg",
+        "thumbnail" => "http://api.randomuser.me/portraits/thumb/women/55.jpg",
+      },
+      "version" => "0.4.1"
+    },
+    "seed" => "graywolf"
+  }
+end

metadata

@@ -0,0 +1,119 @@
+--- !ruby/object:Gem::Specification
+name: random_api
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Brandon
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-12-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.13.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.13.3
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !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.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+description: Provide a ruby interface for pulling data from the Random API, fetching
+  random user data.
+email:
+- lordizuriel@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/random_api.rb
+- lib/random_api/invalid_user_data.rb
+- lib/random_api/service.rb
+- lib/random_api/user.rb
+- lib/random_api/version.rb
+- random_api.gemspec
+- spec/random_api/service_spec.rb
+- spec/random_api/user_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/bbuck/random_api
+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.3
+signing_key: 
+specification_version: 4
+summary: Interface with the Random API https://randomuser.me
+test_files:
+- spec/random_api/service_spec.rb
+- spec/random_api/user_spec.rb
+- spec/spec_helper.rb