fotofetch 0.1.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d0af691137a1f90911465307669bdc22ec978018
-  data.tar.gz: 9fdfcebcdd775ec9d1c8c9fd0e5248326a2edbd9
+  metadata.gz: 8fffabd192e16ce9a554bbe27c720925c3d831bd
+  data.tar.gz: 7b3eb4a2e53e7b280b140a42b05696d633908315
 SHA512:
-  metadata.gz: fdb59a2834c51cff47448a555378261724ffa7fc7e877b42af3c0b0134586edf38381fc771bd4d314bd07d679904324a40afe7faad56fe15a517ed8a29c72457
-  data.tar.gz: f6f976ff5b0857d5567ba2e64024eb39406f85051690fa08e98d0682926c108961aa17de51a1f125587e0d780527e54ad880b2b02ef90a4139ca4e66ef0ff1a0
+  metadata.gz: f70669001c0e5daec9d20da73ccbfca4e983c4d6d8e0fa15d0854eab06cad9b6b518d8100e255fca53942bfdba9e6714615692d8b0c9cf6401e4a8b8f2e565a8
+  data.tar.gz: b77e22d40be89d9d5d80120486a8baf13bbd6158148bf83c7a248632376eb952505e396a775ab6f2142cfe2a9dd4c878d04e0d21158b76f783f807c6722796d9

data/Gemfile.lock

@@ -1,8 +1,8 @@
 PATH
   remote: .
   specs:
-    fotofetch (0.1.0)
-      fastimage
+    fotofetch (1.1.0)
+      fastimage (~> 2.0.0)
       mechanize
 
 GEM
@@ -10,10 +10,10 @@ GEM
   specs:
     addressable (2.4.0)
     byebug (8.2.1)
-    domain_name (0.5.25)
+    domain_name (0.5.20160310)
       unf (>= 0.0.5, < 1.0.0)
-    fastimage (1.8.1)
-      addressable (~> 2.3, >= 2.3.5)
+    fastimage (2.0.0)
+      addressable (~> 2)
     http-cookie (1.0.2)
       domain_name (~> 0.5)
     mechanize (2.7.4)
@@ -25,7 +25,7 @@ GEM
       nokogiri (~> 1.6)
       ntlm-http (~> 0.1, >= 0.1.1)
       webrobots (>= 0.0.9, < 0.2)
-    mime-types (2.99)
+    mime-types (2.99.1)
     mini_portile2 (2.0.0)
     minitest (5.8.3)
     net-http-digest_auth (1.4)
@@ -36,7 +36,7 @@ GEM
     rake (10.4.2)
     unf (0.1.4)
       unf_ext
-    unf_ext (0.0.7.1)
+    unf_ext (0.0.7.2)
     webrobots (0.1.2)
 
 PLATFORMS

data/README.md

@@ -1,15 +1,6 @@
 # Fotofetch
 
-Arguments for fetch_links method are: search value, optional number of links returned,
-and optional dimension restrictions (width, height).
-If a dimension argument is positive, it will look for pictures larger than that,
-and if the number is negative, results will be restricted to those smaller than that.
-Initiate an instance to use: @fetcher = Fotofetch::Fetch.new
-The fetch_links method will return results like: http:example.com/image.jpg)
-To find a 1 small photo of Jupiter, call @fetcher.fetch_links("jupiter", 1, -500, -500).
-To find 3 large photos of Jupiter, call @fetcher.fetch_links("jupiter", 3, 1500, 1500).
-To grab just the first provided photo, call @fetcher.fetch_links("jupiter").
-If a small or large enough image is not found, dimension restrictions will be disregarded.
+This gem allows the simple searching for and saving of images to your app. Various photo-searching API's will provide more consistent results, but this is a quick way to find images matching a query. For instance, I use it to fetch movie posters for a movie suggestions [site](http://www.nonshittymovies.com), which dynamically creates the content on each page load.
 
 ## Installation
 
@@ -27,15 +18,42 @@ Or install it yourself as:
 
     $ gem install fotofetch
 
-## Usage
+## Basic Usage  
+
+- Initiate an instance of Fotofetch:  
+```ruby
+@fetcher = Fotofetch::Fetch.new
+```
+- To fetch an image of a Tesla Model S:
+```ruby
+link = @fetcher.fetch_links("tesla model s")
+```  
+- To save the link to your file directory
+```ruby
+@ff.save_images(link, './')
+```  
+The 'save_images' method takes two arguments: link(s) and the file path for where to save.
 
-TODO: Write usage instructions here
+## More Specific Queries
+Arguments for the 'fetch_links' method are: search value (required), number of links returned (optional), and two dimension restrictions arguments (optional: width, height).  
 
-## Development
+If a dimension argument is positive, it will look for pictures larger than that,
+and if the number is negative, results will be restricted to those smaller than that. Note that adding dimensions restrictions to your query will slow it down.
 
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+- To find a 1 small photo of Jupiter less than 500px x 500px:
+```ruby
+@fetcher.fetch_links("jupiter", 1, -500, -500)
+```
+To find 3 large photos of Jupiter:
+```ruby
+links = @fetcher.fetch_links("jupiter", 3, 1500, 1500)
+```
+And to save all of those links:
+```ruby
+@fetcher.save_images(links, './')
+```
+If a small or large enough image is not found, dimension restrictions will be disregarded.
 
-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).
 
 ## Contributing
 

data/fotofetch.gemspec

@@ -28,7 +28,7 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
 
   spec.add_runtime_dependency "mechanize"
-  spec.add_runtime_dependency "fastimage"
+  spec.add_runtime_dependency "fastimage", "~> 2.0.0"
   spec.add_development_dependency "bundler", "~> 1.10"
   spec.add_development_dependency "rake", "~> 10.0"
   spec.add_development_dependency "minitest"

data/lib/fotofetch/version.rb

@@ -1,3 +1,3 @@
 module Fotofetch
-  VERSION = "0.1.0"
+  VERSION = "1.1.0"
 end

data/test/fotofetch_test.rb

@@ -80,4 +80,9 @@ class FotofetchTest < Minitest::Test
     assert size[1] < 900
   end
 
+  def test_it_dimensions_are_disregarded_if_no_matches_found
+    link = @ff.fetch_links("mars", 1, 10000, 10000).values
+    assert link
+  end
+
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: fotofetch
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Steven Olson
@@ -28,16 +28,16 @@ dependencies:
   name: fastimage
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 2.0.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 2.0.0
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -112,7 +112,6 @@ files:
 - fotofetch.gemspec
 - lib/fotofetch.rb
 - lib/fotofetch/version.rb
-- notes.markdown
 - pkg/fotofetch-0.1.0.gem
 - test/fotofetch_test.rb
 - test/test_helper.rb

data/notes.markdown

@@ -1,10 +0,0 @@
-rake for tests
-uses fastimage to check for image size
-
-methods:
-
-fetch_links(topic, amount?, optional dimension restrictions) returns an array of relevant photo links
-  links = fetch_links('tesla', 2, true)
-
-save_images(urls, filepath)
-  save_images(links, './')