embedly 1.1.0 → 1.2.0

data/Gemfile

@@ -9,5 +9,6 @@ group :development do
   gem "rake"
   gem "rspec"
   gem "yard"
+  gem "aruba"
 end
 

data/README.rdoc

@@ -52,6 +52,18 @@ You can find rdocs at http://rubydoc.info/github/embedly/embedly-ruby/master/fra
   obj = embedly_api.preview :url => url
   puts JSON.pretty_generate(obj[0].marshal_dump)
 
+== Configuration options
+
+You can configure some parameters in the api:
+
+ Embedly.configure do |config|
+   # prints debug messages to the logger
+   config.debug = true
+
+   # use a custom logger
+   config.logger = MyAwesomeLogger.new(STDERR)
+ end
+
 == Testing
 
   gem install jeweler

data/Rakefile

@@ -28,6 +28,12 @@ Jeweler::GemcutterTasks.new
 require 'cucumber/rake/task'
 Cucumber::Rake::Task.new(:features)
 
+require "rspec/core/rake_task"
+RSpec::Core::RakeTask.new(:spec) do |t|
+  t.rspec_opts = %w[--color]
+  t.verbose = false
+end
+
 require 'yard'
 YARD::Rake::YardocTask.new do |t|
     t.files = FileList['lib/**/*.rb'].exclude('lib/jeweler/templates/**/*.rb')
@@ -43,4 +49,6 @@ Rake::RDocTask.new do |rdoc|
   rdoc.rdoc_files.include('lib/**/*.rb')
 end
 
-task :default => :features
+task :all_specs => [:spec, :features]
+
+task :default => :all_specs

data/VERSION

@@ -1 +1 @@
-1.1.0
+1.2.0

data/features/command_line.feature

@@ -0,0 +1,17 @@
+Feature: Command line runner
+  As an embedly user
+  I want to call the the embedly api via command line
+
+  Scenario: Run oembed command
+    When I run `embedly_oembed http://lockerz.com/s/136425091`
+    Then the output should contain:
+      """
+      "provider_url": "http://lockerz.com"
+      """
+
+  Scenario: Run oembed command verbosely
+    When I run `embedly_oembed -v http://lockerz.com/s/136425091`
+    Then the output should contain:
+      """
+      DEBUG -- : calling http://api.embed.ly/1/oembed
+      """

data/features/steps/api_steps.rb

@@ -8,8 +8,8 @@ Given /an embedly api( with key)?$/ do |key_enabled|
   opts = {}
   if key_enabled
     raise 'Please set env variable $EMBEDLY_KEY' unless ENV['EMBEDLY_KEY']
-    opts[:key] = ENV["EMBEDLY_KEY"] 
-    opts[:secret] = ENV["EMBEDLY_SECRET"] 
+    opts[:key] = ENV["EMBEDLY_KEY"]
+    opts[:secret] = ENV["EMBEDLY_SECRET"]
   end
   if not HOSTNAMES[opts]
     HOSTNAMES[opts] = Embedly::API.new opts
@@ -44,18 +44,13 @@ end
 
 Then /([^\s]+) should be (.+)$/ do |key, value|
   raise @error if @error
-  logger = Embedly.logger('api_steps')
-  @result.collect do |o|  
-    logger.debug { "result: #{o.marshal_dump}"}
+  @result.collect do |o|
     o.send(key).to_s
   end.join(',').should == value
 end
 
 Then /([^\s]+) should start with ([^\s]+)/ do |key, value|
   raise @error if @error
-  logger = Embedly.logger('api_steps')
-  logger.debug { "result: #{@result[0].marshal_dump}"}
   v = key.split('.').inject(@result[0]){|o,c| o.send(c)}.to_s
   v.to_s.should match(/^#{value}/)
 end
-

data/features/steps/env.rb

@@ -1,3 +1,10 @@
+require 'aruba/cucumber'
 require 'embedly'
 
-Embedly::Config.logging = true if ENV["EMBEDLY_VERBOSE"]
+Before do
+  @aruba_timeout_seconds = 15
+end
+
+Embedly.configure do |config|
+  config.debug = !!ENV["EMBEDLY_VERBOSE"]
+end

data/lib/embedly.rb

@@ -1,16 +1,14 @@
-require 'logger'
-require 'ostruct'
-
 module Embedly
   VERSION = File.read(File.expand_path('../../VERSION', __FILE__)).strip
-  Config = OpenStruct.new
 
-  def self.logger(name)
-    @_loggers ||= {}
-    logging = Embedly::Config.logging
-    logger = @_loggers[name] ||= Logger.new(STDERR)
-    logger.level = logging ? Logger::DEBUG : Logger::ERROR
-    logger
+  class << self
+    def configure
+      yield configuration
+    end
+
+    def configuration
+      @configuration ||= Configuration.new
+    end
   end
 end
 

data/lib/embedly/api.rb

@@ -2,12 +2,12 @@ require 'net/http'
 require 'net/https'
 require 'json'
 require 'ostruct'
+require 'embedly/configuration'
 require 'embedly/model'
 require 'embedly/exceptions'
 require 'querystring'
 require 'oauth'
 
-
 # Performs api calls to embedly.
 #
 # You won't find methods.  We are using method_missing and passing the method
@@ -39,10 +39,6 @@ require 'oauth'
 class Embedly::API
   attr_reader :key, :hostname, :api_version, :headers, :secret
 
-  def logger *args
-    Embedly.logger *args
-  end
-
   # === Options
   #
   # [:+hostname+] Hostname of embedly server.  Defaults to api.embed.ly.
@@ -72,10 +68,10 @@ class Embedly::API
 
   def _do_oauth_call path
     consumer = OAuth::Consumer.new(key, secret,
-      :site => site, 
+      :site => site,
       :http_method => :get,
       :scheme => :query_string)
-    # our implementation is broken for header authorization, thus the 
+    # our implementation is broken for header authorization, thus the
     # query_string
 
     access_token = OAuth::AccessToken.new consumer
@@ -140,7 +136,7 @@ class Embedly::API
       if response.code.to_i == 200
         logger.debug { response.body }
         # [].flatten is to be sure we have an array
-        objs = [JSON.parse(response.body)].flatten.collect do |o| 
+        objs = [JSON.parse(response.body)].flatten.collect do |o|
           Embedly::EmbedlyObject.new(o)
         end
       else
@@ -218,7 +214,10 @@ class Embedly::API
   end
 
   def logger
-    @logger ||= Embedly.logger('API')
+    configuration.logger
   end
 
+  def configuration
+    Embedly.configuration
+  end
 end

data/lib/embedly/command_line.rb

@@ -89,7 +89,7 @@ Usage [OPTIONS] <url> [url] ..
           parser.separator "Common Options:"
 
           parser.on("-v", "--[no-]verbose", "Run verbosely") do |verbose|
-            Embedly::Config.logging = verbose
+            Embedly.configuration.debug = verbose
           end
 
           parser.on("-h", "--help", "Display this message") do

data/lib/embedly/configuration.rb

@@ -0,0 +1,59 @@
+require 'logger'
+
+# Configure the api
+#
+# === Available settings
+#
+# * [+debug+] Prints debugging information to logger. Default +false+. Errors still will be logged
+# * [+logger+] Configure the logger; set this if you want to use a custom logger.
+#
+# === Usage
+#
+#   Embedly.configure do |config|
+#     # prints debug messages
+#     config.debug = true
+#
+#     # customize the logger
+#     config.logger = MyAwesomeLogger.new(STDERR)
+#   end
+#
+class Embedly::Configuration
+  attr_accessor :key # :nodoc:
+
+  def initialize # :nodoc:
+    self.reset
+  end
+
+  def debug? # :nodoc:
+    self.logger.debug?
+  end
+
+  def debug=(true_or_false) # :nodoc:
+    set_logger_level(true_or_false)
+  end
+
+  def logger # :nodoc:
+    @logger ||= default_logger
+  end
+
+  def logger=(log) # :nodoc:
+    @logger = log
+    set_logger_level(self.debug?)
+  end
+
+  # reset configuration
+  def reset
+    self.logger = default_logger
+    self.debug  = false
+  end
+
+  private
+
+  def default_logger # :nodoc:
+    Logger.new(STDERR)
+  end
+
+  def set_logger_level(true_or_false) # :nodoc:
+    logger.level = true_or_false ? Logger::DEBUG : Logger::ERROR
+  end
+end

data/spec/embedly/api_spec.rb

@@ -0,0 +1,23 @@
+require "spec_helper"
+
+module Embedly
+  describe API do
+    let(:api) { API.new :key => ENV['EMBEDLY_KEY'] }
+
+    describe "logger" do
+      let(:io) { StringIO.new }
+
+      before do
+        Embedly.configure do |c|
+          c.debug  = true
+          c.logger = Logger.new(io)
+        end
+      end
+
+      it "logs if debug is enabled" do
+        api.oembed :url => 'http://blog.doki-pen.org/'
+        io.string.should =~ %r{DEBUG -- : calling http://api.embed.ly/1/oembed?}
+      end
+    end
+  end
+end

data/spec/embedly/command_line_spec.rb

@@ -98,12 +98,12 @@ module Embedly
       describe "with --verbose" do
         it "enables logging" do
           command(["--verbose"])
-          Embedly::Config.logging.should be_true
+          Embedly.configuration.should be_debug
         end
 
         it "disables logging" do
           command(["--no-verbose"])
-          Embedly::Config.logging.should be_false
+          Embedly.configuration.should_not be_debug
         end
       end
     end

data/spec/embedly/configuration_spec.rb

@@ -0,0 +1,57 @@
+require "spec_helper"
+
+module Embedly
+  describe Configuration do
+
+    let(:config) { Configuration.new }
+
+    describe "debug and logging" do
+      let(:logger) { Logger.new(STDERR) }
+
+      it "has debugger disabled by default" do
+        config.should_not have_debug_enabled
+      end
+
+      it "has default logger level as error" do
+        config.logger.level.should == Logger::ERROR
+      end
+
+      it "can enable debugging" do
+        config.debug = true
+        config.should have_debug_enabled
+      end
+
+      it "can disable debugging" do
+        config.debug = false
+        config.should_not have_debug_enabled
+      end
+
+      it "can change the logger" do
+        config.logger = logger
+        config.logger.should === logger
+      end
+
+      it "sets the logger level for the new logger" do
+        config.debug  = true
+        config.logger = logger
+        config.logger.level.should == Logger::DEBUG
+      end
+
+      it "changes the logger level when enable debugging" do
+        config.debug = true
+        config.logger.level.should == Logger::DEBUG
+      end
+    end
+
+    describe "setting options" do
+      it "sets the api key" do
+        config.key = 'my_api_key'
+        config.key.should == 'my_api_key'
+      end
+    end
+  end
+end
+
+RSpec::Matchers.define :have_debug_enabled do
+  match { |actual| actual.debug? }
+end

data/spec/spec_helper.rb

@@ -1 +1,7 @@
 require "embedly"
+
+RSpec.configure do |config|
+  config.after do
+    Embedly.configuration.reset
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: embedly
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.2.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,12 +9,12 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-09-06 00:00:00.000000000 -04:00
+date: 2011-09-12 00:00:00.000000000 -04:00
 default_executable: 
 dependencies:
 - !ruby/object:Gem::Dependency
   name: querystring
-  requirement: &72100880 !ruby/object:Gem::Requirement
+  requirement: &69757780 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -22,10 +22,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *72100880
+  version_requirements: *69757780
 - !ruby/object:Gem::Dependency
   name: oauth
-  requirement: &72100640 !ruby/object:Gem::Requirement
+  requirement: &69752680 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -33,10 +33,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *72100640
+  version_requirements: *69752680
 - !ruby/object:Gem::Dependency
   name: jeweler
-  requirement: &72100400 !ruby/object:Gem::Requirement
+  requirement: &69752030 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -44,10 +44,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *72100400
+  version_requirements: *69752030
 - !ruby/object:Gem::Dependency
   name: cucumber
-  requirement: &72100160 !ruby/object:Gem::Requirement
+  requirement: &69751240 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -55,10 +55,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *72100160
+  version_requirements: *69751240
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &72099920 !ruby/object:Gem::Requirement
+  requirement: &69750240 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -66,10 +66,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *72099920
+  version_requirements: *69750240
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &72099680 !ruby/object:Gem::Requirement
+  requirement: &69749290 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -77,10 +77,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *72099680
+  version_requirements: *69749290
 - !ruby/object:Gem::Dependency
   name: yard
-  requirement: &72099440 !ruby/object:Gem::Requirement
+  requirement: &69748410 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -88,7 +88,18 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *72099440
+  version_requirements: *69748410
+- !ruby/object:Gem::Dependency
+  name: aruba
+  requirement: &69747860 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *69747860
 description: Ruby Embedly client library
 email: bob@embed.ly
 executables:
@@ -111,6 +122,7 @@ files:
 - bin/embedly_oembed
 - bin/embedly_preview
 - cucumber.yml
+- features/command_line.feature
 - features/objectify.feature
 - features/oembed.feature
 - features/steps/api_steps.rb
@@ -118,9 +130,12 @@ files:
 - lib/embedly.rb
 - lib/embedly/api.rb
 - lib/embedly/command_line.rb
+- lib/embedly/configuration.rb
 - lib/embedly/exceptions.rb
 - lib/embedly/model.rb
+- spec/embedly/api_spec.rb
 - spec/embedly/command_line_spec.rb
+- spec/embedly/configuration_spec.rb
 - spec/spec_helper.rb
 has_rdoc: true
 homepage: http://github.com/embedly/embedly-ruby
@@ -138,7 +153,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 930401473
+      hash: -397755075
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements: