cat_api 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: f0702e039ad000739e71865792dea238b9361b74
+  data.tar.gz: 8b3a8912f9b41ac91649e7732849efed0a6c285b
+SHA512:
+  metadata.gz: 4c6d3b12ed1c4f4e4c16d9adb138a2f77c362245e1110b3fa364a0927dc14d85c6a378e10ca879415d8abbee2b21b9bc999c945e42f0afc396fb875f4cfa0777
+  data.tar.gz: 32b77421b0f71cf7ee8917cb72bab55b57eaf34fe77041827f02065745fba2cc82d1a47bb4fe2b56077891dc790cba7446ee60b4b8898deea51efa9f23ef3157

data/.gitignore

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

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 Chris Fritz
+
+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,51 @@
+# CatAPI
+
+I'm not sure how this happened, but there was not yet a Ruby wrapper for the awesome Cat API. Problems solved. I'm putting this together for use in a class, so there are no specs and it only hits a single endpoint, but it's something.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+``` ruby
+gem 'cat_api'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install cat_api
+
+## Usage
+
+Right now, all it does is get cat images.
+
+``` ruby
+client = CatAPI.new
+client.get_images
+```
+
+This will return something like:
+
+``` irb
+=> [#<CatAPI::Image:0x007f863c43b308
+  @id="2hf",
+  @source_url="http://thecatapi.com/?id=2hf",
+  @url="http://30.media.tumblr.com/tumblr_m1o1n5Ajhx1rqyi1go1_1280.png">]
+```
+
+You can get multiple cat images and change other options by passing in parameters from [the Cat API docs](http://thecatapi.com/docs.html#images-get) as a hash. For example, to return 5 cat images at a time:
+
+``` ruby
+client.get_images(results_per_page: 5)
+```
+
+## Contributing
+
+1. [Fork it](https://github.com/chrisvfritz/cat_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 @@
+require 'bundler/gem_tasks'

data/cat_api.gemspec

@@ -0,0 +1,23 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'cat_api/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'cat_api'
+  spec.version       = CatAPI::VERSION
+  spec.authors       = ['Chris Fritz']
+  spec.email         = ['chrisvfritz@gmail.com']
+  spec.summary       = %q{CatAPI is a Ruby gem to facilitate communication with the Cat API.}
+  spec.description   = %q{CatAPI is a Ruby gem to facilitate communication with the Cat API.}
+  spec.homepage      = ''
+  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_development_dependency 'bundler', '~> 1.7'
+  spec.add_development_dependency 'rake', '~> 10.0'
+end

data/lib/cat_api/client.rb

@@ -0,0 +1,25 @@
+require 'rest-client'
+require 'nokogiri'
+require 'cat_api/image_search'
+
+class CatAPI::Client
+
+  BASE_URL = 'http://thecatapi.com/api/'
+
+  def initialize(defaults={})
+    @defaults = defaults
+  end
+
+  def get_images(options={})
+    options = @defaults.merge(options)
+    response = get "#{ BASE_URL }images/get?format=xml&#{ URI.encode_www_form options }"
+    CatAPI::ImageSearch.new( Nokogiri::XML(response) ).results
+  end
+
+private
+
+  def get(url)
+    RestClient.get url
+  end
+
+end

data/lib/cat_api/image.rb

@@ -0,0 +1,10 @@
+class CatAPI::Image
+
+  def initialize(xml)
+    xml.elements.map do |attribute|
+      instance_variable_set "@#{attribute.node_name}", attribute.text
+      CatAPI::Image.class_eval { attr_reader attribute.node_name.to_sym }
+    end
+  end
+
+end

data/lib/cat_api/image_search.rb

@@ -0,0 +1,13 @@
+require 'cat_api/image'
+
+class CatAPI::ImageSearch
+
+  attr_reader :results
+
+  def initialize(xml)
+    @results = xml.xpath('//image').map do |cat|
+      CatAPI::Image.new cat
+    end
+  end
+
+end

data/lib/cat_api/version.rb

@@ -0,0 +1,3 @@
+module CatAPI
+  VERSION = '0.0.1'
+end

data/lib/cat_api.rb

@@ -0,0 +1,14 @@
+require 'cat_api/version'
+require 'cat_api/client'
+
+module CatAPI
+
+  class << self
+
+    def new(options={})
+      Client.new(options)
+    end
+
+  end
+
+end

metadata

@@ -0,0 +1,83 @@
+--- !ruby/object:Gem::Specification
+name: cat_api
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Chris Fritz
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-01-07 00:00:00.000000000 Z
+dependencies:
+- !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'
+description: CatAPI is a Ruby gem to facilitate communication with the Cat API.
+email:
+- chrisvfritz@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- cat_api.gemspec
+- lib/cat_api.rb
+- lib/cat_api/client.rb
+- lib/cat_api/image.rb
+- lib/cat_api/image_search.rb
+- lib/cat_api/version.rb
+homepage: ''
+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: CatAPI is a Ruby gem to facilitate communication with the Cat API.
+test_files: []