image_suckr 0.0.3 → 0.0.4

data/README.md

@@ -1,27 +1,49 @@
 Description
------------
+---
 ImageSuckr is a ruby gem that allows you to get random images from Google for seeding purposes.   
+
 In a future it will support other sources.
 
 Installation
-------------
+---
 1. Add `gem 'image_suckr'` to your Gemfile
 2. Run `bundle install`
   
 Basic use
----------
+---
+**Create an ImageSuckr object:**
+    
     suckr = ImageSuckr::GoogleSuckr.new   
 
-To get a fully random image url:   
+**To get a fully random image URL:**
     
-    suckr.getImageUrl
+    suckr.get_image_url
     
-To get a random image url based on a query:
+**To get a random image URL based on a query:**
 
-    suckr.getImageUrl({"q" => "car"})
+    suckr.get_image_url({"q" => "car"})
 
 _All [Google Image Search API arguments](http://code.google.com/apis/imagesearch/v1/jsondevguide.html#json_args) are supported and you can use them to filter your results._
     
-To get the image content instead of the url:
+**To get the image content instead of the URL:**
+
+    suckr.get_image
+    
+Other useful examples
+---
+    
+**To get a RMagick image:**
+
+_You need to install [RMagick](http://rmagick.rubyforge.org/) to use this._
 
-    suckr.getImage
+    image = Magick::Image.from_blob(suckr.get_image).first
+
+**To get a MiniMagick image:**
+
+_You need to install [MiniMagick](https://github.com/probablycorey/mini_magick) to use this._
+
+    image = MiniMagick::Image.read(suckr.get_image)
+    
+or
+    
+    image = MiniMagick::Image.open(suckr.get_image_url)

data/lib/image_suckr/version.rb

@@ -1,3 +1,3 @@
 module ImageSuckr
-  VERSION = "0.0.3"
+  VERSION = "0.0.4"
 end

data/lib/image_suckr.rb

@@ -16,7 +16,7 @@ module ImageSuckr
       "v" => "1.0"
     }
 
-    def getImageUrl(params = {})
+    def get_image_url(params = {})
       params = DEFAULT_PARAMS.merge(params)
       params["q"] = rand(1000).to_s if params["q"].nil?
       url = "http://ajax.googleapis.com/ajax/services/search/images?" + params.to_query
@@ -25,7 +25,7 @@ module ImageSuckr
       imageUrl = result["responseData"]["results"][rand(params["rsz"].to_i)]["url"] 
     end
 
-    def getImage(params = {})
+    def get_image(params = {})
       image = Net::HTTP.get_response(URI.parse(getImageUrl(params))).body
     end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: image_suckr
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
   prerelease: 
 platform: ruby
 authors: