davetron5000-gliffy 0.1.7 → 0.2.0

data/lib/gliffy/url.rb

@@ -1,67 +1,164 @@
-require 'gliffy/config'
+require 'rubygems'
+require 'hmac-sha1'
+require 'base64'
 
 module Gliffy
+
   # Handles signing and assembling the URL
   class SignedURL
 
-    def initialize(api_key,secret_key,url_root,url)
-      raise ArgumentError.new("api_key is required") if !api_key
-      raise ArgumentError.new("secret_key is required") if !secret_key
-      raise ArgumentError.new("url_root is required") if !url_root
-      raise ArgumentError.new("url is required") if !url_root
-      @logger = Logger.new(Config.config.log_device)
-      @logger.level = Config.config.log_level
-      @params = Hash.new
-      @params['apiKey'] = api_key
-      @secret_key = secret_key
-      @url_root = url_root
+    READ_ONLY_PARAMS = {
+      'oauth_consumer_key' => true,
+      'oauth_token' => true,
+      'oauth_signature_method' => true,
+      'oauth_version' => true,
+      'oauth_nonce' => true,
+      'oauth_timestamp' => true,
+    }
+
+    # Ruby's SignedURL::encode doesn't encode spaces correctly
+    def self.encode(string)
+      string.gsub(/([^ a-zA-Z0-9_.-]+)/n) do
+      '%' + $1.unpack('H2' * $1.size).join('%').upcase
+      end.gsub(' ', '%20')
+    end
+
+    # Modify the logger
+    attr_accessor :logger
+
+    # Create a new SignedURL
+    #
+    # [+credentails+] The credentials available when signing the request (required).
+    # [+url+] The URL (without parameters) to request (required)
+    # [+method+] The HTTP Request method that will be made (required)
+    def initialize(credentials,url,method,logger=nil)
+      raise ArgumentError.new("credentials is required") if credentials.nil?
+      raise ArgumentError.new("url is required") if url.nil?
+      raise ArgumentError.new("method is required") if method.nil?
+
+      @credentials = credentials
+
+      @logger = logger || Logger.new(STDOUT)
+      @logger.level = Logger::INFO
+
+      @params = {
+        'oauth_signature_method' => 'HMAC-SHA1',
+        'oauth_version' => '1.0',
+      }
+      @params['oauth_consumer_key'] = credentials.consumer_key
+      @params['oauth_token'] = credentials.access_token.token if credentials.access_token
+      @consumer_secret = credentials.consumer_secret
+      if credentials.access_token
+        @access_secret = credentials.access_token.secret 
+      else
+        @access_secret = nil
+      end
+      @method = method.upcase
       @url = url
     end
 
     # Sets a request parameter
     #
-    # [param] the name of the parameter, as a string
+    # [param] the name of the parameter, as a string or symbol
     # [value] the value of the parameter, unencoded
     #
     def []=(param,value)
-      if (param == 'apiKey')
-        raise ArgumentError.new('You may not override the api_key in this way')
+      raise ArgumentError.new("param may not be nil") if param.nil?
+      param = param.to_s
+      raise ArgumentError.new("You may not override #{param}") if READ_ONLY_PARAMS[param]
+      if value.nil? 
+        @params.delete(param)
+      else
+        @params[param] = value.to_s
       end
-      @params[param] = value
     end
 
     # Sets all request parameters to those in the hash.
     def params=(params_hash)
-      api_key = @params['apiKey']
-      @params.replace(params_hash)
-      @params['apiKey'] = api_key
+      raise ArgumentError.new('you may not set params to nil') if params_hash.nil?
+      params_hash.each do |k,v|
+        self[k]=v
+      end
     end
 
     # Gets the full URL, signed and ready to be requested
-    def full_url
+    def full_url(timestamp=nil,nonce=nil)
+
       @logger.debug("Getting full_url of #{@url}")
-      to_sign = @url
-      url_params = Hash.new
-      @params.keys.sort.each do |key|
-        @logger.debug("Adding param #{key} (#{to_sign.class.to_s}, #{key.class.to_s}) : #{to_sign.to_s}")
-        to_sign += key
-        to_sign += @params[key].to_s
-        url_params[key.to_s] = @params[key].to_s
-      end
-      to_sign += @secret_key
-      @logger.debug("Signing '#{to_sign}'")
-      signature = Digest::MD5.hexdigest(to_sign)
-      signature.gsub!(/^0/,'') while (signature =~ /^0/)
-      @logger.debug("signature == '#{signature}'")
-      url_params['signature'] = signature
+      @logger.debug("OAuth Part 1 : #{@method}")
+
+      escaped_url = SignedURL::encode(@url)
+      to_sign = @method + "&" + escaped_url + "&"
+
+      @logger.debug("OAuth Part 2 (raw) : #{@url}")
+      @logger.debug("OAuth Part 2 (esc) : #{escaped_url}")
+
+      timestamp=Time.now.to_i if timestamp.nil?
+      nonce=@credentials.nonce if nonce.nil?
 
-      url = @url_root + @url + '?'
+      param_part,url_params = handle_params(timestamp,nonce)
+      escaped_params = SignedURL::encode(param_part)
+      @logger.debug("OAuth Part 3 (raw) : #{param_part}")
+      @logger.debug("OAuth Part 3 (esc) : #{escaped_params}")
+
+      to_sign += escaped_params
+
+      signature = get_signature(to_sign)
+
+      url_params['oauth_signature'] = SignedURL::encode(signature)
+
+      assembled_url = assemble_url(url_params)
+      @logger.debug("Full URL is " + assembled_url)
+      return assembled_url
+    end
+
+    private
+
+    def assemble_url(url_params)
+      url = @url + '?'
       url_params.keys.sort.each do |key|
-        val = CGI::escape(url_params[key])
+        val = url_params[key]
         url += "#{key}=#{val}&"
       end
       url.gsub!(/\&$/,'')
       return url
     end
+
+    def get_signature(to_sign)
+      signing_key = get_signing_key
+      @logger.debug("Signing '#{to_sign}' with key '#{signing_key}'")
+
+      sha1 = HMAC::SHA1.new(signing_key)
+      sha1 << to_sign
+      signature = Base64.encode64(sha1.digest())
+      signature.chomp!
+      @logger.debug("signature == '#{signature}'")
+      signature
+    end
+
+    def get_signing_key
+      SignedURL::encode(@consumer_secret) + "&" + SignedURL::encode(@access_secret.nil? ? "" : @access_secret)
+    end
+
+    def handle_params(timestamp,nonce)
+      url_params = Hash.new
+      param_part = ""
+      params = @params
+      params['oauth_timestamp'] = timestamp.to_s
+      params['oauth_nonce'] = nonce
+      params.keys.sort.each do |key|
+        value = params[key]
+        raise ArgumentError.new("#{key} is nil; don't set params to be nil") if value.nil?
+        
+        @logger.debug("Adding param #{key} with value #{value} escaped as #{SignedURL::encode(value)}")
+        param_part += SignedURL::encode(key)
+        param_part += "="
+        param_part += SignedURL::encode(value)
+        param_part += '&'
+        url_params[key] = SignedURL::encode(value)
+      end
+      param_part.gsub!(/&$/,'')
+      [param_part,url_params]
+    end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: davetron5000-gliffy
 version: !ruby/object:Gem::Version 
-  version: 0.1.7
+  version: 0.2.0
 platform: ruby
 authors: 
 - David Copeland
@@ -9,26 +9,38 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-02-05 00:00:00 -08:00
+date: 2009-05-16 00:00:00 -07:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
-  name: davetron5000-rest-client
+  name: httparty
+  type: :runtime
   version_requirement: 
   version_requirements: !ruby/object:Gem::Requirement 
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        version: 0.5.3
+        version: 0.4.2
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: ruby-hmac
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 0.3.2
     version: 
 - !ruby/object:Gem::Dependency 
   name: davetron5000-gli
+  type: :runtime
   version_requirement: 
   version_requirements: !ruby/object:Gem::Requirement 
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        version: 0.1.4
+        version: 0.1.6
     version: 
 description: 
 email: davidcopeland@naildrivin5.com
@@ -40,25 +52,13 @@ extra_rdoc_files:
 - README.rdoc
 files: 
 - ext/array_has_response.rb
-- bin/gliffy
-- lib/gliffy/account.rb
-- lib/gliffy/cli.rb
-- lib/gliffy/commands/delete.rb
-- lib/gliffy/commands/edit.rb
-- lib/gliffy/commands/get.rb
-- lib/gliffy/commands/list.rb
-- lib/gliffy/commands/new.rb
-- lib/gliffy/commands/url.rb
-- lib/gliffy/commands.rb
-- lib/gliffy/config.rb
-- lib/gliffy/diagram.rb
-- lib/gliffy/folder.rb
+- lib/gliffy/credentials.rb
 - lib/gliffy/handle.rb
+- lib/gliffy/request.rb
 - lib/gliffy/response.rb
-- lib/gliffy/rest.rb
 - lib/gliffy/url.rb
-- lib/gliffy/user.rb
 - lib/gliffy.rb
+- bin/gliffy
 - README.rdoc
 has_rdoc: true
 homepage: http://davetron5000.github.com/gliffy
@@ -91,6 +91,6 @@ rubyforge_project:
 rubygems_version: 1.2.0
 signing_key: 
 specification_version: 2
-summary: client to access the Gliffy API
+summary: Client to access the Gliffy API
 test_files: []
 

data/lib/gliffy/account.rb

@@ -1,55 +0,0 @@
-require 'rexml/document'
-require 'array_has_response'
-require 'gliffy/rest'
-
-include REXML
-
-module Gliffy
-
-  # Represents on account
-  class Account < Response
-
-    attr_reader :name
-    attr_reader :id
-    # Either :basic or :premium
-    attr_reader :type
-    attr_reader :max_users
-    # A Time representing the date on which this account expires
-    attr_reader :expiration_date
-
-    attr_reader :users
-
-    def self.from_xml(element)
-      id = element.attributes['id'].to_i
-      type = element.attributes['account-type']
-      if type == 'Basic'
-        type = :basic
-      elsif type == 'Premium'
-        type = :premium
-      else
-        raise "Unknown type #{type}"
-      end
-      max_users = element.attributes['max-users'].to_i
-      expiration_date = Time.at(element.elements['expiration-date'].text.to_i / 1000)
-      name = element.elements['name'].text
-      users = Users.from_xml(element.elements['users'])
-
-      Account.new(id,type,name,max_users,expiration_date,users)
-    end
-
-    protected
-
-    def initialize(id,type,name,max_users,expiration_date,users=nil)
-      super()
-      @id = id
-      @type = type
-      @name = name
-      @max_users = max_users
-      @expiration_date = expiration_date
-      @users = users
-    end
-
-  end
-
-  class Accounts < ArrayResponseParser; end
-end

data/lib/gliffy/cli.rb

@@ -1,144 +0,0 @@
-$:.unshift File.dirname(__FILE__)
-require 'fileutils'
-require 'yaml'
-require 'gliffy'
-require 'logger'
-
-module Gliffy
-  extend self
-
-  # Represents the configuration for the command line client.
-  # This is a singleton
-  class CLIConfig
-
-    @@instance = nil
-
-    # Access to the singleton
-    def self.instance 
-      @@instance = CLIConfig.new if !@@instance
-      @@instance
-    end
-
-    # Returns the config hash
-    attr_reader :config
-
-    # Loads the user's rc file if it exists, creating it if not
-    def load
-      if !File.exist?(@config_file_name)
-        puts "#{@config_file_name} not found.  Create? [y/n]"
-        answer = STDIN.gets
-        if answer =~ /^[Yy]/
-          save
-        else
-          puts "Aborting..."
-          return false
-        end
-      end
-      yaml_config = File.open(@config_file_name) { |file| YAML::load(file) }
-      if (yaml_config)
-        @config = yaml_config
-      end
-      @config[:open_url] = default_open_url if !@config[:open_url]
-      @config[:open_image] = default_open_image if !@config[:open_image]
-      read_config_from_user('API Key',:api_key)
-      read_config_from_user('Secret Key',:secret_key)
-      read_config_from_user('Account Name',:account_name)
-      read_config_from_user('Username',:username)
-      save
-      config = Gliffy::Config.config
-      @config.each() do |key,value|
-        method = key.to_s + "="
-        if config.respond_to? method.to_sym
-          if (method == 'log_device=')
-            if (value == 'STDERR')
-              config.log_device = STDERR
-            elsif (value == 'STDOUT')
-              config.log_device = STDOUT
-            else
-              config.log_device = value
-            end
-          else
-            config.send(method.to_sym,value)
-          end
-        end
-      end
-    end
-
-    # Saves the configration to the user's config file name as YAML
-    def save
-      ld = @config[:log_device]
-      @config[:log_device] = log_device_to_string(ld)
-      fp = File.open(@config_file_name,'w') { |out| YAML::dump(@config,out) }
-      @config[:log_device] = ld
-    end
-
-    private
-
-    def log_device_to_string(ld)
-      if ld == STDERR
-        'STDERR'
-      elsif ld == STDOUT
-        'STDOUT'
-      elsif !ld.kind_of?(String)
-        puts "Warning: don't know how to persist a #{ld.class.name}"
-        nil
-      else
-        ld
-      end
-    end
-    def read_config_from_user(name,symbol)
-      if (!@config[symbol])
-        puts "No #{name} configured.  Enter #{name}"
-        @config[symbol] = STDIN.gets.chomp!
-      end
-    end
-
-    def initialize
-      @config_file_name = File.expand_path("~/.gliffyrc")
-      @config = {
-        :log_level => Gliffy::Config.config.log_level,
-        :log_device => log_device_to_string(Gliffy::Config.config.log_device),
-        :gliffy_app_root => Gliffy::Config.config.gliffy_app_root,
-        :gliffy_rest_context => Gliffy::Config.config.gliffy_rest_context,
-        :protocol => Gliffy::Config.config.protocol,
-      }
-    end
-
-    def default_open_url
-      # Cheesy defaults
-      if RUBY_PLATFORM =~ /win32/
-        # not sure, acutally
-        nil
-      elsif RUBY_PLATFORM =~ /linux/
-        'firefox "%s"'
-      elsif RUBY_PLATFORM =~ /darwin/
-        'open "%s"'
-      else
-        nil
-      end
-    end
-
-    def default_open_image
-      # Cheesy defaults
-      if RUBY_PLATFORM =~ /win32/
-        # not sure, acutally
-        nil
-      elsif RUBY_PLATFORM =~ /linux/
-        # not sure
-        nil
-      elsif RUBY_PLATFORM =~ /darwin/
-        'open "%s"'
-      else
-        nil
-      end
-    end
-
-
-  end
-
-  def format_date(date)
-    date.strftime('%m/%d/%y %H:%M')
-  end
-
-end
-