yummly 0.0.1 → 0.0.2

data/README.md

@@ -1,6 +1,10 @@
 # Yummly
 
-TODO: Write a gem description
+This is the unofficial ruby wrapper to the Yummly API, "the world's largest and most powerful recipe search site".
+
+https://developer.yummly.com/
+
+Still in the baking phase. Tests are being written, lots of churn at the moment.
 
 ## Installation
 
@@ -16,9 +20,47 @@ Or install it yourself as:
 
     $ gem install yummly
 
-## Usage
+## Configuration
+
+First, configure Yummly with your APP key and ID, for example in an initializer if you're using Rails:
+
+    Yummly.configure do |config|
+      config.app_id = "21334"
+      config.app_key = "XXXXXXXXXXXXXXXXX"
+      config.use_ssl = true # Default is false
+    end
+
+_Note: HTTPS API access is only available on some paid Yummly plans._
+
+## API calls
+
+Once configured, you have access to two API calls:
+
+#### Search
+
+The search command returns an array of Yummly::Recipe objects:
+
+    Yummly::Api.search('Onion soup')
+
+#### Find
+
+The find command returns a single Yummly::Recipe object:
+
+    Yummly::Api.find('French-Onion-Soup-The-Pioneer-Woman-Cooks-_-Ree-Drummond-41364')
+
+## The Recipe object
+
+The Yummly ruby wrapper returns all results as recipe objects. These objects normalize the API responses to make it
+easier for developers to interact with recipes from ruby. All Yummly recipe attributes have been directly mapped, and
+in cases where the JSON response returned an array for a specific attribute and array of related objects are returned
+from the ruby Recipe object.
+
+For example, to access the thumbnail image for a recipe:
+
+    recipe = Yummly::Api.find('French-Onion-Soup-The-Pioneer-Woman-Cooks-_-Ree-Drummond-41364')
+    recipe.images.first.small_url
 
-TODO: Write usage instructions here
+Explore the Yummly::Recipe class to see the full range of available attributes.
 
 ## Contributing
 

data/lib/yummly.rb

@@ -1,4 +1,5 @@
 require "yummly/api"
+require "yummly/connection"
 require "yummly/configuration"
 require "yummly/flavor"
 require "yummly/image"
@@ -21,5 +22,13 @@ module Yummly
       yield(configuration)
       self.configuration = configuration
     end
+
+    def search(terms, params = {})
+      Yummly::Api.search(terms, params)
+    end
+
+    def find(recipe_id)
+      Yummly::Api.find(recipe_id)
+    end
   end
 end

data/lib/yummly/version.rb

@@ -1,3 +1,3 @@
 module Yummly
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: yummly
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
   prerelease: 
 platform: ruby
 authors: