petfinder-wrap 1.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
checksums.yaml ADDED
@@ -0,0 +1,7 @@
1
+ ---
2
+ SHA1:
3
+ metadata.gz: 5aac1d2c8207508529a9ccdf00c0958066db0657
4
+ data.tar.gz: 8ad0045da80784397252b5bfe7108c9f729d7694
5
+ SHA512:
6
+ metadata.gz: 070be214cf4c9f5b37cb37a8344fc130e16522d58cb0d0b34acdcf2bae75a63c8506994feed7b5fcd156ed025620b990d2a60cc0e37d88e0d8a19de9a8c5960d
7
+ data.tar.gz: d56c5a8ae77803ebb30fb7496f8dbc98f24bb67f40ca0ecbe97e17b2f5551d277025ccf3bd1ae3ca14d45d6b8a7c3ca7f0a46340add9e73d7bf23cbad1dddee5
data/.gitignore ADDED
@@ -0,0 +1,12 @@
1
+ /.bundle/
2
+ /.yardoc
3
+ /Gemfile.lock
4
+ /_yardoc/
5
+ /coverage/
6
+ /doc/
7
+ /pkg/
8
+ /spec/reports/
9
+ /tmp/
10
+
11
+ # rspec failure tracking
12
+ .rspec_status
data/.rspec ADDED
@@ -0,0 +1,2 @@
1
+ --format documentation
2
+ --color
data/.travis.yml ADDED
@@ -0,0 +1,5 @@
1
+ sudo: false
2
+ language: ruby
3
+ rvm:
4
+ - 2.4.0
5
+ before_install: gem install bundler -v 1.15.4
data/Gemfile ADDED
@@ -0,0 +1,6 @@
1
+ source "https://rubygems.org"
2
+
3
+ git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
4
+
5
+ # Specify your gem's dependencies in petfinder-wrap.gemspec
6
+ gemspec
data/README.md ADDED
@@ -0,0 +1,35 @@
1
+ # Petfinder::Wrap
2
+
3
+ Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/petfinder/wrap`. To experiment with that code, run `bin/console` for an interactive prompt.
4
+
5
+ TODO: Delete this and the text above, and describe your gem
6
+
7
+ ## Installation
8
+
9
+ Add this line to your application's Gemfile:
10
+
11
+ ```ruby
12
+ gem 'petfinder-wrap'
13
+ ```
14
+
15
+ And then execute:
16
+
17
+ $ bundle
18
+
19
+ Or install it yourself as:
20
+
21
+ $ gem install petfinder-wrap
22
+
23
+ ## Usage
24
+
25
+ TODO: Write usage instructions here
26
+
27
+ ## Development
28
+
29
+ After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
30
+
31
+ To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
32
+
33
+ ## Contributing
34
+
35
+ Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/petfinder-wrap.
data/Rakefile ADDED
@@ -0,0 +1,6 @@
1
+ require "bundler/gem_tasks"
2
+ require "rspec/core/rake_task"
3
+
4
+ RSpec::Core::RakeTask.new(:spec)
5
+
6
+ task :default => :spec
data/bin/console ADDED
@@ -0,0 +1,14 @@
1
+ #!/usr/bin/env ruby
2
+
3
+ require "bundler/setup"
4
+ require "petfinder/wrap"
5
+
6
+ # You can add fixtures and/or initialization code here to make experimenting
7
+ # with your gem easier. You can also use a different console, if you like.
8
+
9
+ # (If you use this, don't forget to add pry to your Gemfile!)
10
+ # require "pry"
11
+ # Pry.start
12
+
13
+ require "irb"
14
+ IRB.start(__FILE__)
data/bin/setup ADDED
@@ -0,0 +1,8 @@
1
+ #!/usr/bin/env bash
2
+ set -euo pipefail
3
+ IFS=$'\n\t'
4
+ set -vx
5
+
6
+ bundle install
7
+
8
+ # Do any other automated setup that you need to do here
@@ -0,0 +1,22 @@
1
+ # require "petfinder/wrap/version"
2
+ require_relative 'petfinder/json-mapper'
3
+ require_relative 'petfinder/pet'
4
+ require_relative 'petfinder/shelter'
5
+ require_relative 'petfinder/client'
6
+ require 'open-uri'
7
+
8
+ module Petfinder
9
+ VERSION = "1.0.0"
10
+
11
+ class Error < StandardError; end
12
+
13
+ class << self
14
+ attr_accessor :api_key, :api_secret
15
+ end
16
+
17
+ def self.configure
18
+ yield self
19
+ true
20
+ end
21
+
22
+ end
@@ -0,0 +1,62 @@
1
+ require 'json'
2
+
3
+ module Petfinder
4
+ API_BASE_URI = "http://api.petfinder.com/"
5
+
6
+ class Client
7
+
8
+ attr_reader :api_key, :api_secret, :response, :request_uri
9
+
10
+ def initialize api_key = Petfinder.api_key, api_secret = Petfinder.api_secret
11
+ @api_key = api_key
12
+ @api_secret = api_secret
13
+ raise Petfinder::Error.new "API key is required" unless @api_key
14
+ end
15
+
16
+ def find_pet id
17
+ find_pet_request = API_BASE_URI + "pet.get?key=#{@api_key}&id=#{id}&format=json"
18
+ response = open(find_pet_request).read
19
+ if resp = JSON.parse(response)
20
+ Petfinder::Pet.new(resp["petfinder"]["pet"])
21
+ else
22
+ raise Petfinder::Error "No valid JSON response from API"
23
+ end
24
+ end
25
+
26
+ def find_pets animal, zip_code
27
+ find_pets_request = API_BASE_URI + "pet.find?key=#{@api_key}&animal=#{animal}&location=#{zip_code}&output=basic&format=json"
28
+ # p find_pets_request
29
+ response = open(find_pets_request).read
30
+ res = []
31
+ if resp = JSON.parse(response)
32
+ resp["petfinder"]["pets"].each do |pet|
33
+ res << Petfinder::Pet.new(pet[1][0])
34
+ end
35
+ end
36
+ res
37
+ end
38
+
39
+ def get_shelter id
40
+ get_shelter_request = API_BASE_URI + "shelter.get?key=#{@api_key}&id=#{id}&format=json"
41
+ response = open(get_shelter_request).read
42
+ if resp = JSON.parse(response)
43
+ Petfinder::Shelter.new(resp["petfinder"]["shelter"])
44
+ else
45
+ raise Petfinder::Error "No valid JSON response from API"
46
+ end
47
+ end
48
+
49
+ def find_shelters location
50
+ find_shelters_request = API_BASE_URI + "shelter.find?key=#{@api_key}&location=#{location}"
51
+ response = open(find_shelters_request).read
52
+
53
+ end
54
+ end
55
+
56
+ private
57
+
58
+ def parse_pet_resp response
59
+
60
+ end
61
+
62
+ end
@@ -0,0 +1,20 @@
1
+ module Petfinder
2
+ module JsonMapper
3
+ def json_attributes(*names)
4
+ names.each { |name| json_attribute(name) }
5
+ end
6
+
7
+ def json_attribute name
8
+ define_method name do
9
+ if name.include? "_"
10
+ camelName = name.split("_").map { |word| word.capitalize unless word == (name.split("_").first) }.join
11
+ @attributes.dig(camelName, "$t")
12
+ elsif @attributes.dig(name, "$t")
13
+ @attributes.dig(name, "$t")
14
+ else
15
+ @attributes["#{name}"]
16
+ end
17
+ end
18
+ end
19
+ end
20
+ end
@@ -0,0 +1,17 @@
1
+ module Petfinder
2
+
3
+ class Pet
4
+ extend JsonMapper
5
+
6
+ json_attributes "name", "breed", "age", "size", "id", "shelter_id",
7
+ "description", "shelter_id"
8
+
9
+ attr_reader :media, :contact
10
+ def initialize pet_hash
11
+ @attributes = pet_hash
12
+ end
13
+
14
+ def contact
15
+ end
16
+ end
17
+ end
@@ -0,0 +1,24 @@
1
+ module Petfinder
2
+ class Shelter
3
+ extend JsonMapper
4
+ json_attributes "country", "name", "phone", "state", "address", "email", "city", "zip", "id"
5
+
6
+ def initialize attributes
7
+ @attributes = attributes
8
+ end
9
+
10
+ def get_pets
11
+ get_shelter_pets = API_BASE_URI + "shelter.getPets?key=#{Client.new.api_key}&id=#{id}&output=basic&format=json"
12
+ response = open(get_shelter_pets).read
13
+ res = []
14
+ if resp = JSON.parse(response)
15
+ resp["petfinder"]["pets"]["pet"].each do |pet|
16
+ # res << Petfinder::Pet.new(pet[1][0])
17
+ res << Pet.new(pet)
18
+ end
19
+ end
20
+ res
21
+ end
22
+
23
+ end
24
+ end
@@ -0,0 +1,38 @@
1
+ # coding: utf-8
2
+ lib = File.expand_path("../lib", __FILE__)
3
+ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
4
+ require "petfinder-wrap"
5
+
6
+ Gem::Specification.new do |spec|
7
+ spec.name = "petfinder-wrap"
8
+ spec.version = Petfinder::VERSION
9
+ spec.authors = ["Pedro De Ona"]
10
+ spec.email = ["pdeon003@fiu.edu"]
11
+
12
+ spec.summary = %q{A Ruby wrapper for the Petfinder RESTful API.}
13
+ spec.homepage = "https://github.com/pdeona/petfinder_wrap"
14
+
15
+ # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
16
+ # to allow pushing to a single host or delete this section to allow pushing to any host.
17
+ # if spec.respond_to?(:metadata)
18
+ # spec.metadata["allowed_push_host"] = "https://rubygems.org"
19
+ # else
20
+ # raise "RubyGems 2.0 or newer is required to protect against " \
21
+ # "public gem pushes."
22
+ # end
23
+
24
+ spec.files = `git ls-files -z`.split("\x0").reject do |f|
25
+ f.match(%r{^(test|spec|features)/})
26
+ end
27
+ spec.bindir = "exe"
28
+ spec.executables = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
29
+ spec.require_paths = ["lib"]
30
+
31
+ spec.add_development_dependency "bundler", "~> 1.15"
32
+ spec.add_development_dependency "rake", "~> 10.0"
33
+ spec.add_development_dependency "rspec", "~> 3.0"
34
+ spec.add_development_dependency "vcr", "~> 3.0"
35
+ spec.add_development_dependency "webmock"
36
+ spec.add_development_dependency "json"
37
+
38
+ end
metadata ADDED
@@ -0,0 +1,141 @@
1
+ --- !ruby/object:Gem::Specification
2
+ name: petfinder-wrap
3
+ version: !ruby/object:Gem::Version
4
+ version: 1.0.0
5
+ platform: ruby
6
+ authors:
7
+ - Pedro De Ona
8
+ autorequire:
9
+ bindir: exe
10
+ cert_chain: []
11
+ date: 2017-09-25 00:00:00.000000000 Z
12
+ dependencies:
13
+ - !ruby/object:Gem::Dependency
14
+ name: bundler
15
+ requirement: !ruby/object:Gem::Requirement
16
+ requirements:
17
+ - - "~>"
18
+ - !ruby/object:Gem::Version
19
+ version: '1.15'
20
+ type: :development
21
+ prerelease: false
22
+ version_requirements: !ruby/object:Gem::Requirement
23
+ requirements:
24
+ - - "~>"
25
+ - !ruby/object:Gem::Version
26
+ version: '1.15'
27
+ - !ruby/object:Gem::Dependency
28
+ name: rake
29
+ requirement: !ruby/object:Gem::Requirement
30
+ requirements:
31
+ - - "~>"
32
+ - !ruby/object:Gem::Version
33
+ version: '10.0'
34
+ type: :development
35
+ prerelease: false
36
+ version_requirements: !ruby/object:Gem::Requirement
37
+ requirements:
38
+ - - "~>"
39
+ - !ruby/object:Gem::Version
40
+ version: '10.0'
41
+ - !ruby/object:Gem::Dependency
42
+ name: rspec
43
+ requirement: !ruby/object:Gem::Requirement
44
+ requirements:
45
+ - - "~>"
46
+ - !ruby/object:Gem::Version
47
+ version: '3.0'
48
+ type: :development
49
+ prerelease: false
50
+ version_requirements: !ruby/object:Gem::Requirement
51
+ requirements:
52
+ - - "~>"
53
+ - !ruby/object:Gem::Version
54
+ version: '3.0'
55
+ - !ruby/object:Gem::Dependency
56
+ name: vcr
57
+ requirement: !ruby/object:Gem::Requirement
58
+ requirements:
59
+ - - "~>"
60
+ - !ruby/object:Gem::Version
61
+ version: '3.0'
62
+ type: :development
63
+ prerelease: false
64
+ version_requirements: !ruby/object:Gem::Requirement
65
+ requirements:
66
+ - - "~>"
67
+ - !ruby/object:Gem::Version
68
+ version: '3.0'
69
+ - !ruby/object:Gem::Dependency
70
+ name: webmock
71
+ requirement: !ruby/object:Gem::Requirement
72
+ requirements:
73
+ - - ">="
74
+ - !ruby/object:Gem::Version
75
+ version: '0'
76
+ type: :development
77
+ prerelease: false
78
+ version_requirements: !ruby/object:Gem::Requirement
79
+ requirements:
80
+ - - ">="
81
+ - !ruby/object:Gem::Version
82
+ version: '0'
83
+ - !ruby/object:Gem::Dependency
84
+ name: json
85
+ requirement: !ruby/object:Gem::Requirement
86
+ requirements:
87
+ - - ">="
88
+ - !ruby/object:Gem::Version
89
+ version: '0'
90
+ type: :development
91
+ prerelease: false
92
+ version_requirements: !ruby/object:Gem::Requirement
93
+ requirements:
94
+ - - ">="
95
+ - !ruby/object:Gem::Version
96
+ version: '0'
97
+ description:
98
+ email:
99
+ - pdeon003@fiu.edu
100
+ executables: []
101
+ extensions: []
102
+ extra_rdoc_files: []
103
+ files:
104
+ - ".gitignore"
105
+ - ".rspec"
106
+ - ".travis.yml"
107
+ - Gemfile
108
+ - README.md
109
+ - Rakefile
110
+ - bin/console
111
+ - bin/setup
112
+ - lib/petfinder-wrap.rb
113
+ - lib/petfinder/client.rb
114
+ - lib/petfinder/json-mapper.rb
115
+ - lib/petfinder/pet.rb
116
+ - lib/petfinder/shelter.rb
117
+ - petfinder-wrap.gemspec
118
+ homepage: https://github.com/pdeona/petfinder_wrap
119
+ licenses: []
120
+ metadata: {}
121
+ post_install_message:
122
+ rdoc_options: []
123
+ require_paths:
124
+ - lib
125
+ required_ruby_version: !ruby/object:Gem::Requirement
126
+ requirements:
127
+ - - ">="
128
+ - !ruby/object:Gem::Version
129
+ version: '0'
130
+ required_rubygems_version: !ruby/object:Gem::Requirement
131
+ requirements:
132
+ - - ">="
133
+ - !ruby/object:Gem::Version
134
+ version: '0'
135
+ requirements: []
136
+ rubyforge_project:
137
+ rubygems_version: 2.6.12
138
+ signing_key:
139
+ specification_version: 4
140
+ summary: A Ruby wrapper for the Petfinder RESTful API.
141
+ test_files: []