punchfork 0.0.3 → 0.0.4

data/README.rdoc

@@ -11,6 +11,7 @@ configure your API key in config/initializers/punchfork.rb
 
  Punchfork.setup do |config|
    config.api_key = 'your-api-key'
+   config.protocol = 'https' # defaults to http
  end
 
 = Usage
@@ -18,16 +19,20 @@ configure your API key in config/initializers/punchfork.rb
 Search for recipes using ingredients:
   
  search = Punchfork.search(:garlic, :tomatoes)
- search['count'] # => 10
- search['recipes'].length # => 10
+ search.count # => 10
+ search.recipes.length # => 10
 
 Any options you pass to the search method will automatically be appended to the querystring sent to punchfork.com.
 For example:
   search = Punchfork.search(:tomato, count:50)
-  search['count'] # => 50
+  search.count # => 50
 
 Check out the full set of options at http://punchfork.com/api#apidocs
 
+= Contact
+
+If you have any issues or questions, please open a ticket through github: https://github.com/gabeodess/Punchfork/issues
+
 = License
 
 This project rocks and uses MIT-LICENSE.

data/lib/punchfork.rb

@@ -4,6 +4,8 @@ module Punchfork
   
   autoload :Configuration, 'punchfork/configuration'
   autoload :Base, 'punchfork/base'
+  autoload :Search, 'punchfork/search'
+  autoload :Recipe, 'punchfork/recipe'
   
   extend Configuration
   extend Base

data/lib/punchfork/base.rb

@@ -1,13 +1,22 @@
 module Punchfork
   module Base
-
+    
+    # Returns a Punchfork::Search object.  Accepts any number of arguments that will be used as ingredients in your search as well as an options hash.
+    # Example: Punchfork.search(:tomatoes, :garlic, {count:5, protocol:'https'})
     def search(*args)
-      options = args.extract_options!
-      search_uri.query = ["key=#{api_key}", "q=#{URI.escape(args.join(','))}", *options.map{ |k,v| "#{k}=#{v}" }].join('&')
-      p ["punchfork search", search_uri.to_s] if Rails.env.test?
-      JSON.load(Net::HTTP.get_response(search_uri).body)
+      Punchfork::Search.new(JSON.load(Net::HTTP.get_response(search_url(*args)).body))
     end
+    
+    # used by #search to query punchfork.com.  Returns a URI object.
+    def search_url(*args)
+      options = args.extract_options!.stringify_keys!
+      protocol = (options['protocol'] || self.protocol).to_s
       
-  end
-        
+      uri = search_uri
+      uri.scheme = protocol
+      uri.query = ["key=#{api_key}", "q=#{URI.escape(args.join(','))}", *options.map{ |k,v| "#{k}=#{v}" }].join('&')
+      return uri
+    end
+      
+  end        
 end

data/lib/punchfork/configuration.rb

@@ -1,8 +1,9 @@
 module Punchfork
   module Configuration
     
-    mattr_accessor :api_key
+    mattr_accessor :api_key, :protocol
     @@api_key = ENV['PUNCHFORK_API_KEY'] || ENV['KEY']
+    @@protocol ||= ENV['PUNCHFORK_PROTOCOL'] || 'http'
     
     mattr_reader :search_uri
     @@search_uri = URI.parse('http://api.punchfork.com/recipes')

data/lib/punchfork/recipe.rb

@@ -0,0 +1,19 @@
+module Punchfork
+  
+  # Wrapper for recipe search results.  Provides dot syntax support.
+  class Recipe
+    
+    def initialize(*args)
+      @hash = args[0]
+      @attributes = {}
+      @hash.each do |k, v|
+        instance_variable_set("@#{k}", v)
+        self.class.class_eval{attr_reader k}
+        @attributes[k] = v
+      end
+    end
+    
+    attr_reader :attributes
+    
+  end
+end

data/lib/punchfork/search.rb

@@ -0,0 +1,28 @@
+module Punchfork
+  
+  # Wrapper for search results providing dot syntax
+  class Search
+    
+    def initialize(*args)
+      @hash = args[0]
+      @attributes = {}
+      
+      @hash.each do |k, v|
+        instance_variable_set("@#{k}", v)
+        self.class.class_eval{attr_reader k}
+        @attributes[k] = v
+      end
+      
+      @recipes = @recipes.map{ |recipe_hash| Recipe.new(recipe_hash) }
+    end
+    
+    attr_reader :attributes
+    
+    def [](key)
+      @hash[key]
+    end
+    
+  end
+  
+  
+end

data/lib/punchfork/version.rb

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

data/test/dummy/db/schema.rb

@@ -0,0 +1,16 @@
+# encoding: UTF-8
+# This file is auto-generated from the current state of the database. Instead
+# of editing this file, please use the migrations feature of Active Record to
+# incrementally modify your database, and then regenerate this schema definition.
+#
+# Note that this schema.rb definition is the authoritative source for your
+# database schema. If you need to create the application database on another
+# system, you should be using db:schema:load, not running all the migrations
+# from scratch. The latter is a flawed and unsustainable approach (the more migrations
+# you'll amass, the slower it'll run and the greater likelihood for issues).
+#
+# It's strongly recommended to check this file into your version control system.
+
+ActiveRecord::Schema.define(:version => 0) do
+
+end

data/test/dummy/log/development.log

@@ -0,0 +1,13 @@
+   (2.0ms)  select sqlite_version(*)
+   (1.3ms)  CREATE TABLE "schema_migrations" ("version" varchar(255) NOT NULL) 
+   (0.0ms)  PRAGMA index_list("schema_migrations")
+   (1.1ms)  CREATE UNIQUE INDEX "unique_schema_migrations" ON "schema_migrations" ("version")
+   (0.3ms)  select sqlite_version(*)
+   (0.2ms)  SELECT "schema_migrations"."version" FROM "schema_migrations" 
+   (0.1ms)  SELECT "schema_migrations"."version" FROM "schema_migrations" 
+   (0.1ms)  select sqlite_version(*)
+   (2.5ms)  CREATE TABLE "schema_migrations" ("version" varchar(255) NOT NULL) 
+   (0.0ms)  PRAGMA index_list("schema_migrations")
+   (1.3ms)  CREATE UNIQUE INDEX "unique_schema_migrations" ON "schema_migrations" ("version")
+   (0.2ms)  SELECT version FROM "schema_migrations"
+   (1.7ms)  INSERT INTO "schema_migrations" (version) VALUES ('0')

data/test/dummy/log/test.log

@@ -1,104 +1,183 @@
    (0.3ms)  begin transaction
    (0.1ms)  rollback transaction
+   (0.1ms)  begin transaction
+   (0.1ms)  rollback transaction
+   (0.1ms)  begin transaction
+   (0.1ms)  rollback transaction
    (0.3ms)  begin transaction
    (0.1ms)  rollback transaction
+   (0.1ms)  begin transaction
+   (0.1ms)  rollback transaction
+   (0.1ms)  begin transaction
+   (0.0ms)  rollback transaction
+   (0.5ms)  begin transaction
+   (0.1ms)  rollback transaction
+   (0.1ms)  begin transaction
+   (0.1ms)  rollback transaction
    (0.0ms)  begin transaction
    (0.0ms)  rollback transaction
    (0.3ms)  begin transaction
    (0.1ms)  rollback transaction
    (0.1ms)  begin transaction
+   (0.2ms)  rollback transaction
+   (0.1ms)  begin transaction
    (0.1ms)  rollback transaction
    (0.3ms)  begin transaction
    (0.1ms)  rollback transaction
    (0.1ms)  begin transaction
+   (0.1ms)  rollback transaction
+   (0.1ms)  begin transaction
    (0.0ms)  rollback transaction
    (0.3ms)  begin transaction
+   (0.1ms)  rollback transaction
+   (0.0ms)  begin transaction
+   (0.1ms)  rollback transaction
+   (0.1ms)  begin transaction
+   (0.1ms)  rollback transaction
+   (0.3ms)  begin transaction
+   (0.1ms)  rollback transaction
+   (0.0ms)  begin transaction
+   (0.1ms)  rollback transaction
+   (0.0ms)  begin transaction
    (0.0ms)  rollback transaction
+   (0.4ms)  begin transaction
+   (0.1ms)  rollback transaction
+   (0.1ms)  begin transaction
+   (0.1ms)  rollback transaction
    (0.0ms)  begin transaction
    (0.0ms)  rollback transaction
    (0.3ms)  begin transaction
    (0.0ms)  rollback transaction
    (0.0ms)  begin transaction
    (0.0ms)  rollback transaction
+   (0.0ms)  begin transaction
+   (0.0ms)  rollback transaction
    (0.3ms)  begin transaction
    (0.1ms)  rollback transaction
+   (0.0ms)  begin transaction
+   (0.1ms)  rollback transaction
    (0.1ms)  begin transaction
    (0.1ms)  rollback transaction
    (0.3ms)  begin transaction
-   (0.0ms)  rollback transaction
+   (0.1ms)  rollback transaction
    (0.0ms)  begin transaction
-   (0.0ms)  rollback transaction
-   (0.4ms)  begin transaction
    (0.1ms)  rollback transaction
    (0.1ms)  begin transaction
-   (0.0ms)  rollback transaction
-   (0.3ms)  begin transaction
    (0.1ms)  rollback transaction
    (0.1ms)  begin transaction
    (0.0ms)  rollback transaction
    (0.3ms)  begin transaction
-   (0.0ms)  rollback transaction
+   (0.1ms)  rollback transaction
+   (0.0ms)  begin transaction
+   (0.1ms)  rollback transaction
+   (0.1ms)  begin transaction
+   (0.1ms)  rollback transaction
    (0.1ms)  begin transaction
-   (0.0ms)  rollback transaction
-   (0.3ms)  begin transaction
    (0.1ms)  rollback transaction
    (0.0ms)  begin transaction
    (0.0ms)  rollback transaction
    (0.3ms)  begin transaction
    (0.1ms)  rollback transaction
+   (0.0ms)  begin transaction
+   (0.1ms)  rollback transaction
    (0.1ms)  begin transaction
-   (0.0ms)  rollback transaction
+   (0.1ms)  rollback transaction
+   (0.0ms)  begin transaction
+
+***** Debugger requested, but was not available (ensure ruby-debug is listed in Gemfile/installed as gem): Start server with --debugger to enable *****
+
+   (0.1ms)  rollback transaction
+   (0.1ms)  begin transaction
+   (0.1ms)  rollback transaction
    (0.3ms)  begin transaction
    (0.1ms)  rollback transaction
+   (0.0ms)  begin transaction
+   (0.1ms)  rollback transaction
    (0.1ms)  begin transaction
+   (0.1ms)  rollback transaction
+   (0.0ms)  begin transaction
+   (0.0ms)  rollback transaction
+   (0.0ms)  begin transaction
    (0.0ms)  rollback transaction
    (0.3ms)  begin transaction
    (0.1ms)  rollback transaction
    (0.1ms)  begin transaction
    (0.1ms)  rollback transaction
-   (0.3ms)  begin transaction
+   (0.0ms)  begin transaction
    (0.1ms)  rollback transaction
    (0.1ms)  begin transaction
    (0.0ms)  rollback transaction
+   (0.0ms)  begin transaction
+   (0.0ms)  rollback transaction
    (0.3ms)  begin transaction
    (0.1ms)  rollback transaction
    (0.1ms)  begin transaction
-   (0.0ms)  rollback transaction
-   (0.3ms)  begin transaction
    (0.1ms)  rollback transaction
    (0.1ms)  begin transaction
    (0.1ms)  rollback transaction
+   (0.1ms)  begin transaction
+   (0.0ms)  rollback transaction
+   (0.1ms)  begin transaction
+   (0.0ms)  rollback transaction
    (0.3ms)  begin transaction
    (0.1ms)  rollback transaction
-   (0.2ms)  begin transaction
+   (0.0ms)  begin transaction
+   (0.1ms)  rollback transaction
+   (0.0ms)  begin transaction
    (0.1ms)  rollback transaction
+   (0.0ms)  begin transaction
+   (0.0ms)  rollback transaction
+   (0.0ms)  begin transaction
+   (0.0ms)  rollback transaction
    (0.3ms)  begin transaction
    (0.1ms)  rollback transaction
    (0.1ms)  begin transaction
    (0.1ms)  rollback transaction
-   (0.3ms)  begin transaction
-   (0.1ms)  rollback transaction
    (0.1ms)  begin transaction
    (0.1ms)  rollback transaction
+   (0.0ms)  begin transaction
+   (0.0ms)  rollback transaction
+   (0.0ms)  begin transaction
+   (0.0ms)  rollback transaction
+   (0.0ms)  begin transaction
+   (0.0ms)  rollback transaction
    (0.3ms)  begin transaction
    (0.1ms)  rollback transaction
    (0.1ms)  begin transaction
    (0.1ms)  rollback transaction
-   (0.3ms)  begin transaction
-   (0.1ms)  rollback transaction
    (0.1ms)  begin transaction
    (0.1ms)  rollback transaction
+   (0.0ms)  begin transaction
+   (0.0ms)  rollback transaction
+   (0.0ms)  begin transaction
+   (0.0ms)  rollback transaction
+   (0.0ms)  begin transaction
+   (0.0ms)  rollback transaction
    (0.3ms)  begin transaction
    (0.1ms)  rollback transaction
    (0.1ms)  begin transaction
+   (0.1ms)  rollback transaction
+   (0.0ms)  begin transaction
+   (0.0ms)  rollback transaction
+   (0.0ms)  begin transaction
+   (0.1ms)  rollback transaction
+   (0.0ms)  begin transaction
+   (0.0ms)  rollback transaction
+   (0.0ms)  begin transaction
+   (0.0ms)  rollback transaction
+   (0.0ms)  begin transaction
    (0.0ms)  rollback transaction
    (0.3ms)  begin transaction
    (0.1ms)  rollback transaction
    (0.1ms)  begin transaction
    (0.1ms)  rollback transaction
-   (0.3ms)  begin transaction
-   (0.1ms)  rollback transaction
    (0.1ms)  begin transaction
+   (0.1ms)  rollback transaction
+   (0.0ms)  begin transaction
+   (0.1ms)  rollback transaction
+   (0.0ms)  begin transaction
+   (0.0ms)  rollback transaction
+   (0.0ms)  begin transaction
    (0.0ms)  rollback transaction
    (0.0ms)  begin transaction
    (0.0ms)  rollback transaction
@@ -106,6 +185,14 @@
    (0.1ms)  rollback transaction
    (0.1ms)  begin transaction
    (0.1ms)  rollback transaction
+   (0.1ms)  begin transaction
+   (0.1ms)  rollback transaction
+   (0.1ms)  begin transaction
+   (0.1ms)  rollback transaction
+   (0.0ms)  begin transaction
+   (0.0ms)  rollback transaction
+   (0.0ms)  begin transaction
+   (0.0ms)  rollback transaction
    (0.0ms)  begin transaction
    (0.0ms)  rollback transaction
    (0.3ms)  begin transaction
@@ -113,22 +200,40 @@
    (0.1ms)  begin transaction
    (0.1ms)  rollback transaction
    (0.1ms)  begin transaction
+   (0.0ms)  rollback transaction
+   (0.1ms)  begin transaction
    (0.1ms)  rollback transaction
-   (0.3ms)  begin transaction
-   (0.1ms)  rollback transaction
+   (0.0ms)  begin transaction
+   (0.0ms)  rollback transaction
    (0.1ms)  begin transaction
    (0.0ms)  rollback transaction
    (0.0ms)  begin transaction
    (0.0ms)  rollback transaction
    (0.3ms)  begin transaction
+   (0.2ms)  rollback transaction
+   (0.1ms)  begin transaction
    (0.1ms)  rollback transaction
    (0.1ms)  begin transaction
    (0.1ms)  rollback transaction
    (0.1ms)  begin transaction
    (0.1ms)  rollback transaction
-   (0.3ms)  begin transaction
+   (0.1ms)  begin transaction
    (0.1ms)  rollback transaction
    (0.1ms)  begin transaction
+   (0.0ms)  rollback transaction
+   (0.1ms)  begin transaction
+   (0.1ms)  rollback transaction
+   (0.3ms)  begin transaction
+   (0.1ms)  rollback transaction
+   (0.0ms)  begin transaction
    (0.1ms)  rollback transaction
    (0.1ms)  begin transaction
    (0.1ms)  rollback transaction
+   (0.0ms)  begin transaction
+   (0.1ms)  rollback transaction
+   (0.0ms)  begin transaction
+   (0.0ms)  rollback transaction
+   (0.0ms)  begin transaction
+   (0.0ms)  rollback transaction
+   (0.0ms)  begin transaction
+   (0.0ms)  rollback transaction

data/test/punchfork_test.rb

@@ -5,6 +5,21 @@ class PunchforkTest < ActiveSupport::TestCase
   def setup
   end
   
+  test "should use http by default" do
+    Punchfork.setup { |config| config.protocol = 'http' }
+    assert_equal 'http', URI.parse(Punchfork.search_url(:tomatoes).to_s).scheme
+  end
+  
+  test "should use https" do
+    Punchfork.setup { |config| config.protocol = 'http' }
+    assert_equal 'https', URI.parse(Punchfork.search_url(:tomatoes, protocol: :https).to_s).scheme
+  end
+  
+  test "should configure default to https" do
+    Punchfork.setup { |config| config.protocol = 'https' }
+    assert_equal 'https', URI.parse(Punchfork.search_url(:tomatoes).to_s).scheme
+  end
+  
   test "truth" do
     assert_kind_of Module, Punchfork
   end
@@ -14,6 +29,11 @@ class PunchforkTest < ActiveSupport::TestCase
     assert_equal 50, response['recipes'].length
   end
   
+  test "should support method calls" do
+    response = Punchfork.search(:tomatoes, count:50)
+    assert_equal 50, response.recipes.length
+  end
+  
   test "search should support strings with spaces" do
     Punchfork.search('Heirloom Tomatoes')
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: punchfork
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-02-02 00:00:00.000000000 Z
+date: 2012-04-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sqlite3
-  requirement: &2155996940 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,7 +21,12 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2155996940
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 description: A simple Ruby library for searching food recipes with punchfork.com
 email:
 - gabeodess@gmail.com
@@ -31,6 +36,8 @@ extra_rdoc_files: []
 files:
 - lib/punchfork/base.rb
 - lib/punchfork/configuration.rb
+- lib/punchfork/recipe.rb
+- lib/punchfork/search.rb
 - lib/punchfork/version.rb
 - lib/punchfork.rb
 - lib/tasks/punchfork_tasks.rake
@@ -58,7 +65,10 @@ files:
 - test/dummy/config/locales/en.yml
 - test/dummy/config/routes.rb
 - test/dummy/config.ru
+- test/dummy/db/development.sqlite3
+- test/dummy/db/schema.rb
 - test/dummy/db/test.sqlite3
+- test/dummy/log/development.log
 - test/dummy/log/test.log
 - test/dummy/public/404.html
 - test/dummy/public/422.html
@@ -83,7 +93,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -2657378380382635552
+      hash: 1201131303701118635
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -92,10 +102,10 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -2657378380382635552
+      hash: 1201131303701118635
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.15
+rubygems_version: 1.8.23
 signing_key: 
 specification_version: 3
 summary: A simple Ruby library for searching food recipes with punchfork.com
@@ -121,7 +131,10 @@ test_files:
 - test/dummy/config/locales/en.yml
 - test/dummy/config/routes.rb
 - test/dummy/config.ru
+- test/dummy/db/development.sqlite3
+- test/dummy/db/schema.rb
 - test/dummy/db/test.sqlite3
+- test/dummy/log/development.log
 - test/dummy/log/test.log
 - test/dummy/public/404.html
 - test/dummy/public/422.html