Added the OAuth signing method

Author: zanker

lib/ruby-smugmug.rb

@@ -1,3 +1,6 @@
 path = File.expand_path("../smugmug", __FILE__)
 require "#{path}/version"
 require "#{path}/exceptions"
+require "#{path}/http"
+require "#{path}/client"
+

lib/smugmug/client.rb

@@ -0,0 +1,29 @@
+module SmugMug
+  class Client
+
+    ##
+    # Creates a new client instance that can be used to access the SMugMug API
+    # @param [Hash] args
+    # @option args [String] :api_key Your SmugMug API key
+    # @option args [String] :oauth_secret Your SmugMug OAuth secret key
+    # @option args [Hash] :user Configuration for the user you are requesting/updating data for
+    #   * :token [String] OAuth token for the user
+    #   * :secret [String] OAuth secret token for the user
+    # @option args [String, Optional :user_agent Helps SmugMug identify API calls
+    # @option args [Hash, Optional] :http Additional configuration for the HTTP requests
+    #   * :verify_mode [Integer, Optional] How to verify the SSL certificate when connecting through HTTPS, either OpenSSL::SSL::VERIFY_PEER or OpenSSL::SSL::VERIFY_NONE, defaults to OpenSSL::SSL::VERIFY_NONE
+    #   * :ca_file [String, Optional] Path to the CA certification file in PEM format
+    #   * :ca_path [String, Optional] Path to the directory containing CA certifications in PEM format
+    #
+    # @raise [ArgumentError]
+    def initialize(args)
+      raise ArgumentError, "API Key required" unless args.has_key?(:api_key)
+      raise ArgumentError, "API OAuth secret required" unless args.has_key?(:oauth_secret)
+      raise ArgumentError, "Must specify the users OAuth datA" unless args[:user].is_a?(Hash)
+      raise ArgumentError, "Users OAuth token required" unless args[:user][:token]
+      raise ArgumentError, "Users OAuth secret token required" unless args[:user][:secret]
+
+      @http = HTTP.new(args)
+    end
+  end
+end

lib/smugmug/http.rb

@@ -0,0 +1,85 @@
+require "cgi"
+require "openssl"
+require "base64"
+require "net/http"
+
+module SmugMug
+  class HTTP
+    API_URI = URI("https://api.smugmug.com/services/api/json/1.3.0")
+
+    ##
+    # Creates a new HTTP wrapper to handle the network portions of the API requests
+    # @param [Hash] args Same as [SmugMug::HTTP]
+    #
+    def initialize(args)
+      @config = args
+      @headers = {"User-Agent" => args.delete(:user_agent) || "Ruby-SmugMug v#{SmugMug::VERSION}"}
+      @digest = OpenSSL::Digest::Digest.new("SHA1")
+    end
+
+    def request(api, args)
+      args[:method] = "smugmug.#{api}"
+
+      http = ::Net::HTTP.new(API_URI.host, API_URI.port)
+      http.set_debug_output(@config[:debug_output]) if @config[:debug_output]
+
+      # Configure HTTPS if needed
+      if API_URI.scheme == "https"
+        http.use_ssl = true
+
+        if @config[:http] and @config[:http][:verify_mode]
+          http.verify_mode = @config[:http][:verify_mode]
+          http.ca_file = @config[:http][:ca_file]
+          http.ca_path = @config[:http][:ca_path]
+        else
+          http.verify_mode = OpenSSL::SSL::VERIFY_NONE
+        end
+      end
+
+      # Parse post data
+      postdata = self.sign_request("POST", API_URI, args)
+
+      response = http.request_post(API_URI.request_uri, postdata, @headers)
+    end
+
+    ##
+    # Generates an OAuth signature and updates the args with the required fields
+    # @param [String] method HTTP method that the request is sent as
+    # @param [String] uri Full URL of the request
+    # @param [Hash] form_args Args to be passed to the server
+    def sign_request(method, uri, form_args)
+      # Convert non-string keys to strings so the sort works
+      args = {}
+      form_args.each do |key, value|
+        next unless value and value != ""
+
+        key = key.to_s unless key.is_a?(String)
+        args[key] = value
+      end
+
+      # Add the necessary OAuth args
+      args["oauth_version"] = "1.0"
+      args["oauth_consumer_key"] = @config[:api_key]
+      args["oauth_nonce"] = Digest::MD5.hexdigest("#{Time.now.to_f}#{rand(10 ** 30)}")
+      args["oauth_signature_method"] = "HMAC-SHA1"
+      args["oauth_timestamp"] = Time.now.utc.to_i
+      args["oauth_token"] = @config[:user][:token]
+
+      # Sort the params
+      sorted_args = []
+      args.sort.each do |key, value|
+        sorted_args.push("#{key.to_s}=#{URI::encode_www_form_component(value.to_s)}")
+      end
+
+      postdata = sorted_args.join("&")
+
+      # Final string to hash
+      sig_base = "#{method}&#{URI::encode_www_form_component("#{uri.scheme}://#{uri.host}#{uri.path}")}&#{URI::encode_www_form_component(postdata)}"
+
+      signature = OpenSSL::HMAC.digest(@digest, "#{@config[:oauth_secret]}&#{@config[:user][:secret]}", sig_base)
+      signature = Base64.encode64(signature).chomp
+
+      "#{postdata}&oauth_signature=#{URI::encode_www_form_component(signature)}"
+    end
+  end
+end