instapaper 0.1.0 → 0.2.0

data/lib/instapaper/request/abstract_request.rb

@@ -1,104 +0,0 @@
-# Copyright (c)  2009 Douglas Willcocks
-#
-# 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.
-
-# An object describing an abstract API request
-
-module Instapaper
-  
-  module Request
-  
-    # The class representing a generic request
-    class AbstractRequest
-
-      include Constants
-      include Exceptions
-      include Protocol
-
-      attr_reader :data
-      attr_reader :url
-
-      def initialize #:nodoc:
-        @validation_callbacks = Array.new
-        @validation_errors    = RequestErrors.new
-        @data                 = Hash.new
-        @abstract             = true
-        @protocol             = PROTOCOLS[:secure]
-        @api                  = false
-        @validated            = false
-      end
-
-      # Prepares the request
-      def prepare
-        build_url
-      end
-
-      # Return a hash of the data to be sent to the server
-      #
-      # Strict determines whether the method raises an exception
-      # or returns an error object
-      def post_data(strict = true)
-        
-        return @data if @validated
-        
-        raise AbstractRequestException.new if @abstract || !@api
-        
-        @validation_callbacks.each do |callback|
-          unless send(callback.method,*callback.args)
-            
-            if strict
-              raise InvalidRequestDetailsException.new(callback.message)
-            else
-              @validation_errors << RequestError.new(callback.message,callback.method)
-            end
-            
-          end
-        end
-        
-        if @validation_errors.valid?
-          @validated = true
-          @data
-        else
-          @validation_errors
-        end
-    
-      end
-
-      private
-
-      def add_validation_callback(callback) #:nodoc:
-        @validation_callbacks << callback unless @validation_callbacks.include?(callback)
-      end
-
-      def build_url #:nodoc:
-        @url = [@protocol,"://",HOST,"/",API_BASE,"/",@api].join('')
-      end
-
-      def has_value(value) #:nodoc:
-        !(value.to_s.nil? || value.to_s.empty? || !value)
-      end
-
-    end
-    
-  end
-    
-end

data/lib/instapaper/request/add_url_request.rb

@@ -1,68 +0,0 @@
-# Copyright (c)  2009 Douglas Willcocks
-#
-# 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.
-
-# The request object that deals with adding urls to Instapaper
-
-module Instapaper
-  module Request
-    
-    class AddURLRequest < AuthenticationRequest
-    
-      include Constants
-    
-      attr_reader :url
-      
-      # Takes a hash of options (see Base#add_url)
-      # and authentication credentials
-      def initialize(opts, username, password = nil)
-        
-        super(username,password)
-        
-        raise InvalidRequestDetailsException.new unless opts.is_a?(Hash)
-        
-        opts = opts.keys.inject({}) do |n,key|
-          n[key.to_s.gsub(/-/,'_').to_sym] = opts[key]
-          n
-        end
-               
-        @data["url"]        = opts[:url]
-        @data["title"]      = opts[:title]      if has_value(opts[:title])
-        @data["selection"]  = opts[:selection]  if has_value(opts[:selection])
-        @data["auto-title"] = opts[:auto_title] if has_value(opts[:auto_title])
-        @api                = API_ADD
-        
-        validation = RequestValidation.new(:validate_url,"You must provide a url!",[])
-        
-        add_validation_callback(validation)        
-      end
-      
-      private
-      
-      def validate_url #:nodoc:
-        has_value(@data["url"])
-      end
-      
-    end
-    
-  end
-end

data/lib/instapaper/request/authentication_request.rb

@@ -1,60 +0,0 @@
-# Copyright (c)  2009 Douglas Willcocks
-#
-# 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.
-
-# The first actual request that can be made
-# Can be used to test the credentials or as the base for all other classes
-
-module Instapaper
-  module Request
-    class AuthenticationRequest < AbstractRequest
-      
-      include Constants
-      
-      attr_reader :username, :password
-      
-      # Use the provided credentials to authenticate against the Instapaper server
-      #
-      # The password is optional
-      def initialize(username, password = nil)
-        super()
-        
-        @abstract        = false
-        
-        @data[:username] = username
-        @data[:password] = password if has_value(password)
-        @api             = API_AUTH
-        
-        validation = RequestValidation.new(:validate_auth,"You must provide a username!",[])
-        
-        add_validation_callback(validation)
-      end
-      
-      private
-      
-      def validate_auth #:nodoc:
-        has_value(@data[:username])
-      end
-      
-    end
-  end
-end

data/lib/instapaper/request/request_error.rb

@@ -1,34 +0,0 @@
-# Copyright (c)  2009 Douglas Willcocks
-#
-# 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.
-
-# A wrapper for an error
-
-module Instapaper
-  
-  module Request
-  
-    RequestError = Struct.new(:message,:type)
-    
-  end
-    
-end

data/lib/instapaper/request/request_errors.rb

@@ -1,41 +0,0 @@
-# Copyright (c)  2009 Douglas Willcocks
-#
-# 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.
-
-# A wrapper for errors
-
-module Instapaper
-  
-  module Request
-
-    class RequestErrors < Array
-
-      # Is the request valid?
-      def valid?
-       empty?
-      end
-
-     end
-    
-  end
-
-end

data/lib/instapaper/request/request_validation.rb

@@ -1,34 +0,0 @@
-# Copyright (c)  2009 Douglas Willcocks
-#
-# 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.
-
-# A small struct containing validation info
-
-module Instapaper
-  
-  module Request
-    
-    RequestValidation = Struct.new(:method,:message,:args)
-    
-  end
-  
-end

data/lib/instapaper/response.rb

@@ -1,10 +0,0 @@
-$:.unshift(File.dirname(__FILE__)) unless
-  $:.include?(File.dirname(__FILE__)) || $:.include?(File.expand_path(File.dirname(__FILE__)))
-
-require 'response/response_builder'
-require 'response/abstract_response'
-require 'response/add_url_success_response'
-require 'response/authentication_success_response'
-require 'response/authentication_invalid_response'
-require 'response/bad_request_response'
-require 'response/service_error_response'

data/lib/instapaper/response/abstract_response.rb

@@ -1,38 +0,0 @@
-# Copyright (c)  2009 Douglas Willcocks
-#
-# 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.
-
-module Instapaper
-  module Response
-    class AbstractResponse
-      
-      attr_reader :request, :code, :message
-      
-      def initialize(request) #:nodoc:
-        @request = request
-        @code    = nil
-        @message = nil
-      end
-      
-    end
-  end
-end

data/lib/instapaper/response/add_url_success_response.rb

@@ -1,41 +0,0 @@
-# Copyright (c)  2009 Douglas Willcocks
-#
-# 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.
-
-module Instapaper
-  module Response
-    
-    class AddURLSuccessResponse < AbstractResponse #:nodoc: all
-      
-      def initialize(request)
-        super
-        
-        @code    = 201
-        @message = "URL Added Successfully"
-        
-      end
-      
-      
-    end
-    
-  end
-end

data/lib/instapaper/response/authentication_invalid_response.rb

@@ -1,40 +0,0 @@
-# Copyright (c)  2009 Douglas Willcocks
-#
-# 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.
-
-module Instapaper
-  module Response
-    
-    class AuthenticationInvalidResponse < AbstractResponse #:nodoc: all
-      
-      def initialize(request)
-        super
-        
-        @code    = 403
-        @message = "Authentication Unsuccessful"
-        
-      end
-      
-    end
-    
-  end
-end