ted_api 0.1

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in ted_api.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2012 John Barton
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,56 @@
+# TedApi Client
+
+This gem wraps the TED Talks API making calls using Faraday.  It includes support for both Hashie parsed JSON and XML in addition to providing raw response formats.  It contains a 1:1 match for all API calls including the duplicate and somewhat useless ones such as languages and events.  All calls are tested for both JSON and XML responses.
+
+You will need a TED API key to consume the API and there are currently only 50 that have been given out.  I was lucky enough that my proposal was accepted to receive one for my TED-API-50 project.  Hopefully they will open up the API to the public soon so that I won't have written this gem for the 50 of us.  See http://developer.ted.com/ for additional information.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'ted_api'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install ted_api
+
+## Usage
+
+Basic usage 
+
+The wrapper defaults to json responses for the API:
+
+	@client = TedApi::Client.new(api_key: 'xxx')
+	
+	# Returns a list of talks:
+	@client.talks
+	
+	# Returns a specific talk id
+	@client.talks(1)
+
+Consuming the XML API is very straightforward:
+
+	@client = TedApi::Client.new(api_key: 'xxx', response_format='xml')
+	
+To bypass Hashie and ParseXML or ParseJSON for the raw response, just set raw to true:
+	
+	@client.talks(1, {}, true)
+
+To pass additional options:
+
+	@client.speakers(nil, {filter: 'lastname:Kurzweil'})
+
+See http://developer.ted.com/API_Docs for additional details
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request
+

data/Rakefile

@@ -0,0 +1,8 @@
+require 'bundler'
+Bundler::GemHelper.install_tasks
+
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec)
+
+task :test => :spec
+task :default => :spec

data/lib/faraday/response/raise_ted_api_error.rb

@@ -0,0 +1,43 @@
+require 'faraday'
+require 'multi_json'
+
+module Faraday
+  class Response::RaiseTedApiError < Response::Middleware
+    def on_complete(response)
+      case response[:status].to_i
+      when 400
+        raise TedApi::BadRequest, error_message(response)
+      when 401
+        raise TedApi::Unauthorized, error_message(response)
+      when 403
+        raise TedApi::Forbidden, error_message(response)
+      when 404
+        raise TedApi::NotFound, error_message(response)
+      when 406
+        raise TedApi::NotAcceptable, error_message(response)
+      when 422
+        raise TedApi::UnprocessableEntity, error_message(response)
+      when 500
+        raise TedApi::InternalServerError, error_message(response)
+      when 501
+        raise TedApi::NotImplemented, error_message(response)
+      when 502
+        raise TedApi::BadGateway, error_message(response)
+      when 503
+        raise TedApi::ServiceUnavailable, error_message(response)
+      end
+    end
+
+    def error_message(response)
+      message = if (body = response[:body]) && !body.empty?
+        if body.is_a?(String)
+          body = MultiJson.load(body, :symbolize_keys => true)
+        end
+        ": #{body[:error] || body[:message] || ''}"
+      else
+        ''
+      end
+      "#{response[:method].to_s.upcase} #{response[:url].to_s}: #{response[:status]}#{message}"
+    end
+  end
+end

data/lib/ted_api.rb

@@ -0,0 +1,20 @@
+require 'ted_api/version'
+require 'ted_api/configuration'
+require 'ted_api/client'
+require 'ted_api/error'
+
+module TedApi
+  extend Configuration
+  class << self
+    # Alias for TedApi::Client.new
+    #
+    # @return [TedApi::Client]
+    def new(options={})
+      TedApi::Client.new(options)
+    end
+
+    def respond_to?(method, include_private=false)
+      new.respond_to?(method, include_private) || super(method, include_private)
+    end
+  end
+end

data/lib/ted_api/client.rb

@@ -0,0 +1,39 @@
+require 'ted_api/connection'
+require 'ted_api/request'
+require 'ted_api/error'
+
+require 'ted_api/client/talks'
+require 'ted_api/client/events'
+require 'ted_api/client/languages'
+require 'ted_api/client/quotes'
+require 'ted_api/client/rating_words'
+require 'ted_api/client/speakers'
+require 'ted_api/client/themes'
+require 'ted_api/client/countries'
+require 'ted_api/client/tags'
+
+module TedApi
+  class Client
+    attr_accessor(*Configuration::VALID_OPTIONS_KEYS)
+
+    def initialize(options={})
+      options = TedApi.options.merge(options)
+      Configuration::VALID_OPTIONS_KEYS.each do |key|
+        send("#{key}=", options[key])
+      end
+    end
+    
+    include TedApi::Connection
+    include TedApi::Request
+    include TedApi::Client::Talks
+    include TedApi::Client::Events
+    include TedApi::Client::Languages
+    include TedApi::Client::Quotes
+    include TedApi::Client::RatingWords
+    include TedApi::Client::Speakers
+    include TedApi::Client::Themes
+    include TedApi::Client::Countries
+    include TedApi::Client::Tags
+    
+  end
+end

data/lib/ted_api/client/countries.rb

@@ -0,0 +1,18 @@
+module TedApi
+  class Client
+    module Countries
+      
+      ##
+      # http://developer.ted.com/API_Docs#countries
+      
+      def countries(country=nil, options={}, raw=false)
+        if country.nil?
+          get('countries', options, raw)
+        else
+          get("countries/#{country}", options, raw)
+        end
+      end
+      
+    end
+  end
+end

data/lib/ted_api/client/events.rb

@@ -0,0 +1,18 @@
+module TedApi
+  class Client
+    module Events
+      
+      ##
+      # http://developer.ted.com/API_Docs#events
+      
+      def events(event=nil, options={}, raw=false)
+        if event.nil?
+          get('events', options, raw)
+        else
+          get("events/#{event}", options, raw)
+        end
+      end
+      
+    end
+  end
+end

data/lib/ted_api/client/languages.rb

@@ -0,0 +1,18 @@
+module TedApi
+  class Client
+    module Languages
+      
+      ##
+      # http://developer.ted.com/API_Docs#languages
+      
+      def languages(language=nil, options={}, raw=false)
+        if language.nil?
+          get('languages', options, raw)
+        else
+          get("languages/#{language}", options, raw)
+        end
+      end
+      
+    end
+  end
+end

data/lib/ted_api/client/quotes.rb

@@ -0,0 +1,18 @@
+module TedApi
+  class Client
+    module Quotes
+      
+      ##
+      # http://developer.ted.com/API_Docs#quotes
+      
+      def quotes(quote=nil, options={}, raw=false)
+        if quote.nil?
+          get('quotes', options, raw)
+        else
+          get("quotes/#{quote}", options, raw)
+        end
+      end
+      
+    end
+  end
+end

data/lib/ted_api/client/rating_words.rb

@@ -0,0 +1,18 @@
+module TedApi
+  class Client
+    module RatingWords
+      
+      ##
+      # http://developer.ted.com/API_Docs#rating_words
+      
+      def rating_words(rating_word=nil, options={}, raw=false)
+        if rating_word.nil?
+          get('rating_words', options, raw)
+        else
+          get("rating_words/#{rating_word}", options, raw)
+        end
+      end
+      
+    end
+  end
+end

data/lib/ted_api/client/speakers.rb

@@ -0,0 +1,18 @@
+module TedApi
+  class Client
+    module Speakers
+      
+      ##
+      # http://developer.ted.com/API_Docs#speakers
+      
+      def speakers(speaker=nil, options={}, raw=false)
+        if speaker.nil?
+          get('speakers', options, raw)
+        else
+          get("speakers/#{speaker}", options, raw)
+        end
+      end
+      
+    end
+  end
+end

data/lib/ted_api/client/tags.rb

@@ -0,0 +1,18 @@
+module TedApi
+  class Client
+    module Tags
+      
+      ##
+      # http://developer.ted.com/API_Docs#tags
+      
+      def tags(tag=nil, options={}, raw=false)
+        if tag.nil?
+          get('tags', options, raw)
+        else
+          get("tags/#{tag}", options, raw)
+        end
+      end
+      
+    end
+  end
+end

data/lib/ted_api/client/talks.rb

@@ -0,0 +1,26 @@
+module TedApi
+  class Client
+    module Talks
+      
+      ##
+      # http://developer.ted.com/API_Docs#talks
+      
+      def talks(talk=nil, options={}, raw=false)
+        if talk.nil?
+          get('talks', options, raw)
+        else
+          get("talks/#{talk}", options, raw)
+        end
+      end
+      
+      def subtitles(talk, options={}, raw=false)
+        get("talks/#{talk}/subtitles", options, raw)
+      end
+      
+      def speakers_by_talk(talk, options={}, raw=false)
+        get("talks/#{talk}/speakers", options, raw)
+      end
+      
+    end
+  end
+end

data/lib/ted_api/client/themes.rb

@@ -0,0 +1,18 @@
+module TedApi
+  class Client
+    module Themes
+      
+      ##
+      # http://developer.ted.com/API_Docs#themes
+      
+      def themes(theme=nil, options={}, raw=false)
+        if theme.nil?
+          get('themes', options, raw)
+        else
+          get("themes/#{theme}", options, raw)
+        end
+      end
+      
+    end
+  end
+end

data/lib/ted_api/configuration.rb

@@ -0,0 +1,54 @@
+require 'faraday'
+require 'ted_api/version'
+
+module TedApi
+  module Configuration
+    VALID_OPTIONS_KEYS = [
+      :adapter,
+      :api_version,
+      :api_endpoint,
+      :web_endpoint,
+      :api_key,
+      :response_format,
+      :user_agent].freeze
+
+    DEFAULT_ADAPTER = Faraday.default_adapter
+    DEFAULT_API_VERSION = 'v1'
+    DEFAULT_API_ENDPOINT = 'https://api.ted.com/'
+    DEFAULT_WEB_ENDPOINT = 'https://ted.com/'
+    DEFAULT_USER_AGENT = "ted-api ruby gem #{TedApi::VERSION}".freeze
+    DEFAULT_RESPONSE_FORMAT = 'json'
+
+    attr_accessor(*VALID_OPTIONS_KEYS)
+
+    def self.extended(base)
+      base.reset
+    end
+
+    def configure
+      yield self
+    end
+
+    def options
+      VALID_OPTIONS_KEYS.inject({}){|o,k| o.merge!(k => send(k)) }
+    end
+
+    def api_endpoint=(value)
+      @api_endpoint = File.join(value, "")
+    end
+
+    def web_endpoint=(value)
+      @web_endpoint = File.join(value, "")
+    end
+
+    def reset
+      self.adapter = DEFAULT_ADAPTER
+      self.api_version = DEFAULT_API_VERSION
+      self.api_endpoint = DEFAULT_API_ENDPOINT
+      self.web_endpoint = DEFAULT_WEB_ENDPOINT
+      self.api_key = nil
+      self.response_format = DEFAULT_RESPONSE_FORMAT
+      self.user_agent = DEFAULT_USER_AGENT
+    end
+  end
+end