wsnaps 1.0 → 1.0.1

data/lib/worksnaps/client.rb

@@ -0,0 +1,76 @@
+require 'faraday'
+#require 'simple_oauth'
+require 'worksnaps/error'
+require 'worksnaps/api/users'
+require 'worksnaps/api/tasks'
+require 'worksnaps/api/projects'
+require 'worksnaps/api/user_assignments'
+require 'worksnaps/api/task_assignments'
+
+module WorkSnaps
+  class Client
+    include WorkSnaps::API::Users
+    include WorkSnaps::API::Tasks
+    include WorkSnaps::API::Projects
+    include WorkSnaps::API::UserAssignments
+    include WorkSnaps::API::TaskAssignments
+
+    # Initializes a new Client object
+    #
+    # @param options [Hash]
+    # @return [WorkSnaps::Client]
+    def initialize(options={})
+      Wsnaps.keys.each do |key|
+        instance_variable_set(:"@#{key}", options[key] || WorkSnaps.instance_variable_get(:"@#{key}"))
+      end
+    end
+
+    # Perform an HTTP DELETE request
+    def delete(path, params={})
+      request(:delete, path, params)
+    end
+
+    # Perform an HTTP GET request
+    def get(path, params={})
+      request(:get, path, params)
+    end
+
+    # Perform an HTTP POST request
+    def post(path, params={})
+      signature_params = params.values.any?{|value| value.respond_to?(:to_io)} ? {} : params
+      request(:post, path, params.to_xml, signature_params)
+    end
+
+    # Perform an HTTP PUT request
+    def put(path, params={})
+      request(:put, path, params)
+    end
+
+  private
+
+    def request(method, path, params={}, signature_params=params)
+      connection.send(method.to_sym, path, params) do |request|
+        request.headers[:authorization] = auth_header(method.to_sym, path, signature_params).to_s
+      end.env
+    rescue Faraday::Error::ClientError
+      raise WorkSnaps::Error::ClientError
+    end
+
+    # Returns a Faraday::Connection object
+    #
+    # @return [Faraday::Connection]
+    def connection
+      @connection ||= Faraday.new(@endpoint, @connection_options.merge(:builder => @middleware))
+    end
+
+    def auth_header(method, path, params={})
+      # Oauth
+      # uri = URI(@endpoint + path)
+      # SimpleOAuth::Header.new(method, uri, params, WorkSnaps.oauth_credentials)
+
+      # Basic auth
+      Faraday::Request::BasicAuthentication.header(Wsnaps.api_tocken, '')
+    end
+
+  end
+end

data/lib/worksnaps/default.rb

@@ -0,0 +1,94 @@
+require 'faraday'
+require 'worksnaps/error/client_error'
+require 'worksnaps/error/server_error'
+#require 'faraday/request/multipart'
+#require 'worksnaps/request/multipart_with_file'
+#require 'worksnaps/response/parse_json'
+require 'worksnaps/response/parse_xml'
+require 'worksnaps/response/raise_error'
+require 'worksnaps/version'
+
+module WorkSnaps
+  module Default
+    ENDPOINT = 'http://www.worksnaps.net' unless defined? WorkSnaps::Default::ENDPOINT
+    CONNECTION_OPTIONS = {
+      :headers => {
+        :accept => 'application/xml',
+        'Content-Type' => 'application/xml',
+        :user_agent => "WorkSnaps Ruby Gem #{WorkSnaps::Version}",
+      },
+      :request => {
+        :open_timeout => 5,
+        :timeout => 10,
+      },
+      :ssl => {
+        :verify => false
+      },
+    } unless defined? WorkSnaps::Default::CONNECTION_OPTIONS
+    IDENTITY_MAP = false unless defined? WorkSnaps::Default::IDENTITY_MAP
+    MIDDLEWARE = Faraday::Builder.new do |builder|
+      # Convert request params to "www-form-urlencoded"
+      builder.use Faraday::Request::UrlEncoded
+      # Parse response in XML format to hash
+      builder.use WorkSnaps::Response::ParseXML
+      # Handle 4xx server responses
+      builder.use WorkSnaps::Response::RaiseError, WorkSnaps::Error::ClientError
+      # Handle 5xx server responses
+      builder.use WorkSnaps::Response::RaiseError, WorkSnaps::Error::ServerError
+      # Set Faraday's HTTP adapter
+      builder.adapter Faraday.default_adapter
+    end unless defined? WorkSnaps::Default::MIDDLEWARE
+
+    class << self
+      def options
+        Hash[Wsnaps.keys.map{|key| [key, send(key)]}]
+      end
+
+      # @return [String]
+      def api_tocken
+        ENV['WORKSNAPS_API_TOCKEN']
+      end
+
+      # @return [String]
+      def consumer_key
+        ENV['WORKSNAPS_CONSUMER_KEY']
+      end
+
+      # @return [String]
+      def consumer_secret
+        ENV['WORKSNAPS_CONSUMER_SECRET']
+      end
+
+      # @return [String]
+      def oauth_token
+        ENV['WORKSNAPS_OAUTH_TOKEN']
+      end
+
+      # @return [String]
+      def oauth_token_secret
+        ENV['WORKSNAPS_OAUTH_TOKEN_SECRET']
+      end
+
+      def endpoint
+        ENDPOINT
+      end
+
+      def connection_options
+        CONNECTION_OPTIONS
+      end
+
+      def identity_map
+        IDENTITY_MAP
+      end
+
+      # @note Faraday's middleware stack implementation is comparable to that of Rack middleware.  The order of middleware is important: the first middleware on the list wraps all others, while the last middleware is the innermost one.
+      # @see https://github.com/technoweenie/faraday#advanced-middleware-usage
+      # @see http://mislav.uniqpath.com/2011/07/faraday-advanced-http/
+      # @return [Faraday::Builder]
+      def middleware
+        MIDDLEWARE
+      end
+
+    end
+  end
+end

data/lib/worksnaps/error.rb

@@ -0,0 +1,22 @@
+module WorkSnaps
+  class Error < StandardError
+    attr_reader :wrapped_exception
+
+    def self.errors
+      @errors ||= Hash[descendants.map{|klass| [klass.const_get(:HTTP_STATUS_CODE), klass]}]
+    end
+
+    def self.descendants
+      ObjectSpace.each_object(::Class).select{|klass| klass < self}
+    end
+
+    def initialize(exception=$!, response_headers={})
+      @wrapped_exception = exception
+      exception.respond_to?(:backtrace) ? super(exception.message) : super(exception.to_s)
+    end
+
+    def backtrace
+      @wrapped_exception.respond_to?(:backtrace) ? @wrapped_exception.backtrace : super
+    end
+  end
+end

data/lib/worksnaps/error/already_favorited.rb

@@ -0,0 +1,10 @@
+require 'worksnaps/error/forbidden'
+
+module WorkSnaps
+  class Error
+    # Raised when a Tweet has already been favorited
+    class AlreadyFavorited < WorkSnaps::Error
+      MESSAGE = "You have already favorited this status"
+    end
+  end
+end

data/lib/worksnaps/error/already_retweeted.rb

@@ -0,0 +1,10 @@
+require 'worksnaps/error/forbidden'
+
+module WorkSnaps
+  class Error
+    # Raised when a Tweet has already been retweeted
+    class AlreadyRetweeted < WorkSnaps::Error
+      MESSAGE = "sharing is not permissible for this status (Share validations failed)"
+    end
+  end
+end

data/lib/worksnaps/error/bad_gateway.rb

@@ -0,0 +1,11 @@
+require 'worksnaps/error/server_error'
+
+module WorkSnaps
+  class Error
+    # Raised when WorkSnaps returns the HTTP status code 502
+    class BadGateway < WorkSnaps::Error::ServerError
+      HTTP_STATUS_CODE = 502
+      MESSAGE = "WorkSnaps is down or being upgraded."
+    end
+  end
+end

data/lib/worksnaps/error/bad_request.rb

@@ -0,0 +1,10 @@
+require 'worksnaps/error/client_error'
+
+module WorkSnaps
+  class Error
+    # Raised when WorkSnaps returns the HTTP status code 400
+    class BadRequest < WorkSnaps::Error::ClientError
+      HTTP_STATUS_CODE = 400
+    end
+  end
+end

data/lib/worksnaps/error/client_error.rb

@@ -0,0 +1,35 @@
+require 'worksnaps/error'
+
+module WorkSnaps
+  class Error
+    # Raised when WorkSnaps returns a 4xx HTTP status code or there's an error in Faraday
+    class ClientError < WorkSnaps::Error
+
+      # Create a new error from an HTTP environment
+      #
+      # @param response [Hash]
+      # @return [WorkSnaps::Error]
+      def self.from_response(response={})
+        new(parse_error(response[:body]), response[:response_headers])
+      end
+
+    private
+
+      def self.parse_error(body)
+        if body.nil?
+          ''
+        elsif body[:error]
+          body[:error]
+        elsif body[:errors]
+          first = Array(body[:errors]).first
+          if first.is_a?(Hash)
+            first[:message].chomp
+          else
+            first.chomp
+          end
+        end
+      end
+
+    end
+  end
+end

data/lib/worksnaps/error/configuration_error.rb

@@ -0,0 +1,8 @@
+require 'worksnaps/error'
+
+module WorkSnaps
+  class Error
+    class ConfigurationError < ::ArgumentError
+    end
+  end
+end

data/lib/worksnaps/error/decode_error.rb

@@ -0,0 +1,9 @@
+require 'worksnaps/error'
+
+module WorkSnaps
+  class Error
+    # Raised when JSON parsing fails
+    class DecodeError < WorkSnaps::Error
+    end
+  end
+end

data/lib/worksnaps/error/forbidden.rb

@@ -0,0 +1,10 @@
+require 'worksnaps/error/client_error'
+
+module WorkSnaps
+  class Error
+    # Raised when WorkSnaps returns the HTTP status code 403
+    class Forbidden < WorkSnaps::Error::ClientError
+      HTTP_STATUS_CODE = 403
+    end
+  end
+end

data/lib/worksnaps/error/gateway_timeout.rb

@@ -0,0 +1,11 @@
+require 'worksnaps/error/server_error'
+
+module WorkSnaps
+  class Error
+    # Raised when WorkSnaps returns the HTTP status code 504
+    class GatewayTimeout < WorkSnaps::Error::ServerError
+      HTTP_STATUS_CODE = 504
+      MESSAGE = "The WorkSnaps servers are up, but the request couldn't be serviced due to some failure within our stack. Try again later."
+    end
+  end
+end

data/lib/worksnaps/error/identity_map_key_error.rb

@@ -0,0 +1,9 @@
+require 'worksnaps/error'
+
+module WorkSnaps
+  class Error
+    # Inherit from KeyError when Ruby 1.8 compatibility is removed
+    class IdentityMapKeyError < ::IndexError
+    end
+  end
+end

data/lib/worksnaps/error/internal_server_error.rb

@@ -0,0 +1,11 @@
+require 'worksnaps/error/server_error'
+
+module WorkSnaps
+  class Error
+    # Raised when WorkSnaps returns the HTTP status code 500
+    class InternalServerError < WorkSnaps::Error::ServerError
+      HTTP_STATUS_CODE = 500
+      MESSAGE = "Something is technically wrong."
+    end
+  end
+end

data/lib/worksnaps/error/not_acceptable.rb

@@ -0,0 +1,10 @@
+require 'worksnaps/error/client_error'
+
+module WorkSnaps
+  class Error
+    # Raised when WorkSnaps returns the HTTP status code 406
+    class NotAcceptable < WorkSnaps::Error::ClientError
+      HTTP_STATUS_CODE = 406
+    end
+  end
+end

data/lib/worksnaps/error/not_found.rb

@@ -0,0 +1,10 @@
+require 'worksnaps/error/client_error'
+
+module WorkSnaps
+  class Error
+    # Raised when WorkSnaps returns the HTTP status code 404
+    class NotFound < WorkSnaps::Error::ClientError
+      HTTP_STATUS_CODE = 404
+    end
+  end
+end

data/lib/worksnaps/error/server_error.rb

@@ -0,0 +1,28 @@
+require 'worksnaps/error'
+
+module WorkSnaps
+  class Error
+    # Raised when WorkSnaps returns a 5xx HTTP status code
+    class ServerError < WorkSnaps::Error
+      MESSAGE = "Server Error"
+
+      # Create a new error from an HTTP environment
+      #
+      # @param response [Hash]
+      # @return [WorkSnaps::Error]
+      def self.from_response(response={})
+        new(nil, response[:response_headers])
+      end
+
+      # Initializes a new ServerError object
+      #
+      # @param message [String]
+      # @param response_headers [Hash]
+      # @return [WorkSnaps::Error::ServerError]
+      def initialize(message=nil, response_headers={})
+        super((message || self.class.const_get(:MESSAGE)), response_headers)
+      end
+
+    end
+  end
+end

data/lib/worksnaps/error/service_unavailable.rb

@@ -0,0 +1,11 @@
+require 'worksnaps/error/server_error'
+
+module WorkSnaps
+  class Error
+    # Raised when WorkSnaps returns the HTTP status code 503
+    class ServiceUnavailable < WorkSnaps::Error::ServerError
+      HTTP_STATUS_CODE = 503
+      MESSAGE = "(__-){ WorkSnaps is over capacity."
+    end
+  end
+end

data/lib/worksnaps/error/too_many_requests.rb

@@ -0,0 +1,12 @@
+require 'worksnaps/error/client_error'
+
+module WorkSnaps
+  class Error
+    # Raised when WorkSnaps returns the HTTP status code 429
+    class TooManyRequests < WorkSnaps::Error::ClientError
+      HTTP_STATUS_CODE = 429
+    end
+    EnhanceYourCalm = TooManyRequests
+    RateLimited = TooManyRequests
+  end
+end

data/lib/worksnaps/error/unauthorized.rb

@@ -0,0 +1,8 @@
+module WorkSnaps
+  class Error
+    class Unauthorized < WorkSnaps::Error
+      HTTP_STATUS_CODE = 401
+    end
+  end
+end
+

data/lib/worksnaps/error/unprocessable_entity.rb

@@ -0,0 +1,10 @@
+require 'worksnaps/error/client_error'
+
+module WorkSnaps
+  class Error
+    # Raised when WorkSnaps returns the HTTP status code 404
+    class UnprocessableEntity < WorkSnaps::Error::ClientError
+      HTTP_STATUS_CODE = 422
+    end
+  end
+end