smoodit 0.0.1

data/.gitignore

@@ -0,0 +1,11 @@
+*.gem
+*.rbc
+.DS_Store
+.bundle
+.rvmrc
+.yardoc
+Gemfile.lock
+coverage/*
+doc/*
+log/*
+pkg/*

data/.rspec

@@ -0,0 +1,3 @@
+--color
+--format=nested
+--backtrace

data/.yardopts

@@ -0,0 +1,9 @@
+--no-private
+--protected
+--tag format:"Supported formats"
+--tag authenticated:"Requires Authentication"
+--tag rate_limited:"Rate Limited"
+--markup markdown
+-
+HISTORY.mkd
+LICENSE.mkd

data/Gemfile

@@ -0,0 +1,3 @@
+source "http://rubygems.org"
+
+gemspec

data/HISTORY.mkd

@@ -0,0 +1,3 @@
+0.0.1 - November 26, 2006
+-------------------------
+* [Initial release](https://github.com/potomak/smoodit/commit/...)

data/LICENSE.mkd

@@ -0,0 +1,20 @@
+Copyright (c) 2010 Giovanni Cappellotto
+
+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.mkd

@@ -0,0 +1,155 @@
+#The Smood it Ruby Gem
+
+A Ruby wrapper for the Smood it REST API
+
+##Documentation
+
+The full Smood it API reference could be found at [http://smood.it/api](http://smood.it/api)
+
+##Installation
+
+    gem install smoodit
+
+##Follow @smoodit on Twitter
+
+You should [follow @smoodit on Twitter](http://twitter.com/smoodit) for announcements,
+updates, and news about the smoodit gem.
+
+##Usage Examples
+
+    require "rubygems"
+    require "smoodit"
+
+    # Certain methods require authentication. To get your Smood it OAuth credentials,
+    # register an app at http://smood.it/oauth_clients/new
+    Smoodit.configure do |config|
+      config.consumer_key = YOUR_CONSUMER_KEY
+      config.consumer_secret = YOUR_CONSUMER_SECRET
+      config.oauth_token = YOUR_OAUTH_TOKEN
+      config.oauth_token_secret = YOUR_OAUTH_TOKEN_SECRET
+    end
+
+    # Get informations about your profile
+    Smoodit.profile do |me|
+      puts me.name
+    end
+
+    # Get informations about giovanni's profile
+    Smoodit.giovanni do |giovanni|
+      puts giovanni.name
+    end
+
+    # Get giovanni's followers
+    Smoodit.giovanni.followers do |response|
+      response.followers.each do |smooder|
+        puts smooder.name
+      end
+    end
+
+    # Get giovanni's following
+    Smoodit.giovanni.following do |response|
+      response.following.each do |smooder|
+        puts smooder.name
+      end
+    end
+
+    # Follow giovanni
+    Smoodit.giovanni do |giovanni|
+      Smoodit.users(giovanni.id).follow.post do |response, status|
+        if status == 201 # created
+          puts "you don't follow giovanni anymore"
+        else
+          puts "an error has occurred"
+        end
+      end
+    end
+
+    # Unfollow giovanni
+    Smoodit.giovanni do |giovanni|
+      Smoodit.users(giovanni.id).unfollow.post do |response, status|
+        if status == 204 # no content
+          puts "you don't follow giovanni anymore"
+        else
+          puts "an error has occurred"
+        end
+      end
+    end
+
+    # Get your smoods
+    Smoodit.profile.smoods do |response|
+      response.smoods.each do |smood|
+        puts smood.mood
+      end
+    end
+
+    # Get giovanni's smoods
+    Smoodit.giovanni.smoods do |response|
+      response.smoods.each do |smood|
+        puts smood.mood
+      end
+    end
+
+    # Create a new smood
+    Smoodit.smoods.post(:smood => {:mood => :joy}) do |response, status|
+      if status == 201 # created
+        puts "you've smooded"
+      else
+        puts "an error has occurred"
+      end
+    end
+
+    # Delete smood
+    smood_id = 123
+    Smoodit.smoods(smood_id).delete do |response, status|
+      if status == 204 # no content
+        puts "you've smooded"
+      else
+        puts "an error has occurred"
+      end
+    end
+
+##Contributing
+
+In the spirit of [free software](http://www.fsf.org/licensing/essays/free-sw.html), **everyone** is encouraged to help improve this project.
+
+Here are some ways *you* can contribute:
+
+* by using alpha, beta, and prerelease versions
+* by reporting bugs
+* by suggesting new features
+* by writing or editing documentation
+* by writing specifications
+* by writing code (**no patch is too small**: fix typos, add comments, clean up inconsistent whitespace)
+* by refactoring code
+* by closing [issues](http://github.com/potomak/smoodit/issues)
+* by reviewing patches
+<!-- * [financially](http://pledgie.com/campaigns/TODO) -->
+
+All contributors will be added to the [HISTORY](https://github.com/potomak/smoodit/blob/master/HISTORY.mkd)
+file and will receive the respect and gratitude of the community.
+
+##Submitting an Issue
+
+We use the [GitHub issue tracker](http://github.com/potomak/smoodit/issues) to track bugs and
+features. Before submitting a bug report or feature request, check to make sure it hasn't already
+been submitted. You can indicate support for an existing issuse by voting it up. When submitting a
+bug report, please include a [Gist](http://gist.github.com/) that includes a stack trace and any
+details that may be necessary to reproduce the bug, including your gem version, Ruby version, and
+operating system. Ideally, a bug report should include a pull request with failing specs.
+
+##Submitting a Pull Request
+
+1. Fork the project.
+2. Create a topic branch.
+3. Implement your feature or bug fix.
+4. Add documentation for your feature or bug fix.
+5. Run `bundle exec rake doc:yard`. If your changes are not 100% documented, go back to step 4.
+6. Add specs for your feature or bug fix.
+7. Run `bundle exec rake spec`. If your changes are not 100% covered, go back to step 6.
+8. Commit and push your changes.
+9. Submit a pull request. Please do not include changes to the gemspec, version, or history file. (If you want to create your own version for some reason, please do so in a separate commit.)
+
+##Copyright
+
+Copyright (c) 2010 Giovanni Cappellotto.
+See [LICENSE](https://github.com/potomak/smoodit/blob/master/LICENSE.mkd) for details.

data/Rakefile

@@ -0,0 +1,22 @@
+require 'bundler'
+Bundler::GemHelper.install_tasks
+
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec
+
+namespace :doc do
+  require 'yard'
+  YARD::Rake::YardocTask.new do |task|
+    task.files   = ['HISTORY.mkd', 'LICENSE.mkd', 'lib/**/*.rb']
+    task.options = [
+      '--protected',
+      '--output-dir', 'doc/yard',
+      '--tag', 'format:Supported formats',
+      '--tag', 'authenticated:Requires Authentication',
+      '--tag', 'rate_limited:Rate Limited',
+      '--markup', 'markdown',
+    ]
+  end
+end

data/lib/faraday/multipart.rb

@@ -0,0 +1,30 @@
+require 'faraday'
+
+# @private
+module Faraday
+  # @private
+  class Request::Multipart < Faraday::Middleware
+    def call(env)
+      if env[:body].is_a?(Hash)
+        env[:body].each do |key, value|
+          if value.is_a?(File)
+            env[:body][key] = Faraday::UploadIO.new(value, mime_type(value), value.path)
+          end
+        end
+      end
+
+      @app.call(env)
+    end
+
+    private
+
+    def mime_type(file)
+      case file.path
+        when /\.jpe?g/i then 'image/jpeg'
+        when /\.gif$/i then 'image/gif'
+        when /\.png$/i then 'image/png'
+        else 'application/octet-stream'
+      end
+    end
+  end
+end

data/lib/faraday/oauth.rb

@@ -0,0 +1,22 @@
+require 'faraday'
+require 'simple_oauth'
+
+# @private
+module Faraday
+  # @private
+  class Request::OAuth < Faraday::Middleware
+    def call(env)
+      params = env[:body].is_a?(Hash) ? env[:body] : {}
+      signature_params = params.reject{|k,v| v.respond_to?(:content_type) }
+      header = SimpleOAuth::Header.new(env[:method], env[:url], signature_params, @options)
+
+      env[:request_headers]['Authorization'] = header.to_s
+
+      @app.call(env)
+    end
+
+    def initialize(app, options)
+      @app, @options = app, options
+    end
+  end
+end

data/lib/faraday/raise_http_4xx.rb

@@ -0,0 +1,50 @@
+require 'faraday'
+
+# @private
+module Faraday
+  # @private
+  class Response::RaiseHttp4xx < Response::Middleware
+    def self.register_on_complete(env)
+      env[:response].on_complete do |response|
+        case response[:status].to_i
+        when 400
+          raise Smoodit::BadRequest, error_message(response)
+        when 401
+          raise Smoodit::Unauthorized, error_message(response)
+        when 403
+          raise Smoodit::Forbidden, error_message(response)
+        when 404
+          raise Smoodit::NotFound, error_message(response)
+        when 406
+          raise Smoodit::NotAcceptable, error_message(response)
+        end
+      end
+    end
+
+    def initialize(app)
+      super
+      @parser = nil
+    end
+
+    private
+
+    def self.error_message(response)
+      "#{response[:method].to_s.upcase} #{response[:url].to_s}: #{response[:status]}#{error_body(response[:body])}"
+    end
+
+    def self.error_body(body)
+      if body.nil?
+        nil
+      elsif body['error']
+        ": #{body['error']}"
+      elsif body['errors']
+        first = body['errors'].to_a.first
+        if first.kind_of? Hash
+          ": #{first['message'].chomp}"
+        else
+          ": #{first.chomp}"
+        end
+      end
+    end
+  end
+end

data/lib/faraday/raise_http_5xx.rb

@@ -0,0 +1,31 @@
+require 'faraday'
+
+# @private
+module Faraday
+  # @private
+  class Response::RaiseHttp5xx < Response::Middleware
+    def self.register_on_complete(env)
+      env[:response].on_complete do |response|
+        case response[:status].to_i
+        when 500
+          raise Smoodit::InternalServerError, error_message(response, "Something is technically wrong.")
+        when 502
+          raise Smoodit::BadGateway, error_message(response, "Smood it is down or being upgraded.")
+        when 503
+          raise Smoodit::ServiceUnavailable, error_message(response, "(__-){ Smood it is over capacity.")
+        end
+      end
+    end
+
+    def initialize(app)
+      super
+      @parser = nil
+    end
+
+    private
+
+    def self.error_message(response, body=nil)
+      "#{response[:method].to_s.upcase} #{response[:url].to_s}: #{[response[:status].to_s + ':', body].compact.join(' ')} Check http://status.smood.it/ for updates on the status of the Smood it service."
+    end
+  end
+end

data/lib/smoodit/api.rb

@@ -0,0 +1,23 @@
+require File.expand_path('../connection', __FILE__)
+require File.expand_path('../request', __FILE__)
+require File.expand_path('../authentication', __FILE__)
+
+module Smoodit
+  # @private
+  class API
+    # @private
+    attr_accessor *Configuration::VALID_OPTIONS_KEYS
+
+    # Creates a new API
+    def initialize(options={})
+      options = Smoodit.options.merge(options)
+      Configuration::VALID_OPTIONS_KEYS.each do |key|
+        send("#{key}=", options[key])
+      end
+    end
+
+    include Connection
+    include Request
+    include Authentication
+  end
+end

data/lib/smoodit/authentication.rb

@@ -0,0 +1,25 @@
+module Smoodit
+  # @private
+  module Authentication
+    private
+
+    # Authentication hash
+    #
+    # @return [Hash]
+    def authentication
+      {
+        :consumer_key => consumer_key,
+        :consumer_secret => consumer_secret,
+        :token => oauth_token,
+        :token_secret => oauth_token_secret
+      }
+    end
+
+    # Check whether user is authenticated
+    #
+    # @return [Boolean]
+    def authenticated?
+      authentication.values.all?
+    end
+  end
+end

data/lib/smoodit/client/proxy.rb

@@ -0,0 +1,46 @@
+# -*- encoding: utf-8 -*-
+module Smoodit
+  class Client
+    class Proxy
+      attr_reader :options, :verb, :path
+
+      def initialize
+        @verb = :get
+        @keys = []
+        @ids = {}
+        @options = {}
+        @path = ""
+      end
+
+      def append(key, id=nil, options={})
+        @verb = key.to_sym if ["get", "post", "put", "delete"].include? key.to_s
+        @keys << key unless ["get", "post", "put", "delete"].include? key.to_s
+        @ids[key.to_sym] = id if id
+        @options = @options.merge(options) if options
+      end
+
+      def compose_request
+        # puts "@keys: #{@keys.inspect}"
+        # puts "@ids: #{@ids.inspect}"
+        # puts "@options: #{@options.inspect}"
+        
+        # compose request path
+        @path = @keys.collect do |key|
+          if id = @ids.delete(key.to_sym)
+            "#{key}/#{id}"
+          else
+            key
+          end
+        end.join("/")
+        
+        # puts to_s
+
+        self
+      end
+
+      def to_s
+        "#{@verb.to_s.upcase} /#{@path} OPTIONS: #{@options.inspect}"
+      end
+    end
+  end
+end

data/lib/smoodit/client.rb

@@ -0,0 +1,55 @@
+module Smoodit
+  # Wrapper for the Smoodit REST API
+  #
+  # @note See the {http://smood.it/api Smoodit API Documentation} for more informations.
+  # @see http://smood.it/api
+  class Client < API
+    # Require client method modules after initializing the Client class in
+    # order to avoid a superclass mismatch error, allowing those modules to be
+    # Client-namespaced.
+    Dir[File.expand_path('../client/*.rb', __FILE__)].each{|f| require f}
+
+    alias :api_endpoint :endpoint
+    
+    attr_reader :proxy
+    
+    def initialize(options={})
+      super(options)
+      @proxy = Proxy.new
+    end
+    
+    # Delegate to Smoodit::Client
+    def method_missing(method, *args, &block)
+      options = args.last.is_a?(Hash) ? args.pop : {}
+      id = args.last ? args.pop : nil
+      
+      # puts "method: #{method}"
+      # puts "options: #{options.inspect}"
+      # puts "id: #{id}"
+      
+      @proxy.append(method, id, options)
+      
+      if block_given?
+        @proxy.compose_request
+        raw = @proxy.options.delete(:raw)
+        response, status = send(:request, @proxy.verb, @proxy.path, @proxy.options, raw)
+        case block.arity
+        when 0, -1
+          yield
+        when 1
+          yield response
+        when 2
+          yield response, status
+        end
+      end
+      
+      self
+      
+      # begin
+      #   send(verb, path, options)
+      # rescue Yajl::ParseError => e
+      #   puts "error: #{e}"
+      # end
+    end
+  end
+end

data/lib/smoodit/configuration.rb

@@ -0,0 +1,94 @@
+require 'faraday'
+require File.expand_path('../version', __FILE__)
+
+module Smoodit
+  # Defines constants and methods related to configuration
+  module Configuration
+    # An array of valid keys in the options hash when configuring a {Smoodit::API}
+    VALID_OPTIONS_KEYS = [
+      :adapter,
+      :consumer_key,
+      :consumer_secret,
+      :endpoint,
+      :format,
+      :oauth_token,
+      :oauth_token_secret,
+      :proxy,
+      :user_agent].freeze
+
+    # An array of valid request/response formats
+    #
+    # @note Not all methods support the XML format.
+    VALID_FORMATS = [
+      :json,
+      :xml].freeze
+
+    # The adapter that will be used to connect if none is set
+    #
+    # @note The default faraday adapter is Net::HTTP.
+    DEFAULT_ADAPTER = Faraday.default_adapter
+
+    # By default, don't set an application key
+    DEFAULT_CONSUMER_KEY = nil
+
+    # By default, don't set an application secret
+    DEFAULT_CONSUMER_SECRET = nil
+
+    # The endpoint that will be used to connect if none is set
+    #
+    # @note This is configurable in case you want to use HTTP instead of HTTPS, specify a different API version, or use a Smoodit-compatible endpoint.
+    #DEFAULT_ENDPOINT = 'http://smood.it/'.freeze
+    DEFAULT_ENDPOINT = 'http://localhost:3000/'.freeze
+
+    # The response format appended to the path and sent in the 'Accept' header if none is set
+    #
+    # @note JSON is preferred over XML because it is more concise and faster to parse.
+    DEFAULT_FORMAT = :json
+
+    # By default, don't set a user oauth token
+    DEFAULT_OAUTH_TOKEN = nil
+
+    # By default, don't set a user oauth secret
+    DEFAULT_OAUTH_TOKEN_SECRET = nil
+
+    # By default, don't use a proxy server
+    DEFAULT_PROXY = nil
+
+    # The user agent that will be sent to the API endpoint if none is set
+    DEFAULT_USER_AGENT = "Smoodit Ruby Gem #{Smoodit::VERSION}".freeze
+
+    # @private
+    attr_accessor *VALID_OPTIONS_KEYS
+
+    # When this module is extended, set all configuration options to their default values
+    def self.extended(base)
+      base.reset
+    end
+
+    # Convenience method to allow configuration options to be set in a block
+    def configure
+      yield self
+    end
+
+    # Create a hash of options and their values
+    def options
+      VALID_OPTIONS_KEYS.inject({}) do |option, key|
+        option.merge!(key => send(key))
+      end
+    end
+
+    # Reset all configuration options to defaults
+    def reset
+      self.adapter            = DEFAULT_ADAPTER
+      self.consumer_key       = DEFAULT_CONSUMER_KEY
+      self.consumer_secret    = DEFAULT_CONSUMER_SECRET
+      self.endpoint           = DEFAULT_ENDPOINT
+      self.format             = DEFAULT_FORMAT
+      self.oauth_token        = DEFAULT_OAUTH_TOKEN
+      self.oauth_token_secret = DEFAULT_OAUTH_TOKEN_SECRET
+      self.proxy              = DEFAULT_PROXY
+      self.user_agent         = DEFAULT_USER_AGENT
+      self
+    end
+  end
+end

data/lib/smoodit/connection.rb

@@ -0,0 +1,38 @@
+require 'faraday_middleware'
+Dir[File.expand_path('../../faraday/*.rb', __FILE__)].each{|f| require f}
+
+module Smoodit
+  # @private
+  module Connection
+    private
+
+    def connection(raw=false)
+      options = {
+        :headers => {
+          'Accept' => "application/#{format}",
+          'Content-type' => "application/#{format}",
+          'User-Agent' => user_agent
+        },
+        :proxy => proxy,
+        :ssl => {:verify => false},
+        :url => api_endpoint,
+      }
+
+      Faraday::Connection.new(options) do |builder|
+        builder.use Faraday::Request::Multipart
+        builder.use Faraday::Request::Yajl if format == :json
+        builder.use Faraday::Request::OAuth, authentication if authenticated?
+        builder.adapter(adapter)
+        builder.use Faraday::Response::RaiseHttp5xx
+        unless raw
+          case format.to_s.downcase
+          when 'json' then builder.use Faraday::Response::ParseJson
+          when 'xml' then builder.use Faraday::Response::ParseXml
+          end
+        end
+        builder.use Faraday::Response::RaiseHttp4xx
+        builder.use Faraday::Response::Mashify unless raw
+      end
+    end
+  end
+end

data/lib/smoodit/error.rb

@@ -0,0 +1,28 @@
+module Smoodit
+  # Custom error class for rescuing from all Smood it errors
+  class Error < StandardError; end
+
+  # Raised when Smood it returns the HTTP status code 400
+  class BadRequest < Error; end
+
+  # Raised when Smood it returns the HTTP status code 401
+  class Unauthorized < Error; end
+
+  # Raised when Smood it returns the HTTP status code 403
+  class Forbidden < Error; end
+
+  # Raised when Smood it returns the HTTP status code 404
+  class NotFound < Error; end
+
+  # Raised when Smood it returns the HTTP status code 406
+  class NotAcceptable < Error; end
+
+  # Raised when Smood it returns the HTTP status code 500
+  class InternalServerError < Error; end
+
+  # Raised when Smood it returns the HTTP status code 502
+  class BadGateway < Error; end
+
+  # Raised when Smood it returns the HTTP status code 503
+  class ServiceUnavailable < Error; end
+end