davetron5000-gliffy 0.1.7 → 0.2.0

data/lib/gliffy/commands.rb

@@ -1,6 +0,0 @@
-require 'gliffy/commands/list'
-require 'gliffy/commands/delete'
-require 'gliffy/commands/url'
-require 'gliffy/commands/get'
-require 'gliffy/commands/edit'
-require 'gliffy/commands/new'

data/lib/gliffy/commands/delete.rb

@@ -1,10 +0,0 @@
-desc 'Delete a diagram'
-arg_name 'diagram_id [diagram_id]*'
-command [:delete,:del,:rm] do |c|
-  c.action do |global_options,options,args|
-    raise UnknownArgumentException("diagram id is required") if args.length == 0;
-    args.each do |diagram_id|
-      $gliffy.delete_diagram(diagram_id)
-    end
-  end
-end

data/lib/gliffy/commands/edit.rb

@@ -1,19 +0,0 @@
-desc 'Edit a diagram'
-arg_name 'diagram_id'
-command :edit do |c|
-
-  c.action do |global_options,options,args|
-
-    raise(UnknownArgumentException,'You must specify one diagram id') if args.length != 1
-
-    return_link = $gliffy.get_diagram_as_url(args[0])
-    link = $gliffy.get_edit_diagram_link(args[0],return_link,"Done")
-    if Gliffy::CLIConfig.instance.config[:open_url]
-      system(sprintf(Gliffy::CLIConfig.instance.config[:open_url],link.full_url))
-    else
-      puts "Nothing configured for #{:open_url.to_s} to open the url"
-      puts link.full_url
-    end
-  end
-end
-

data/lib/gliffy/commands/get.rb

@@ -1,46 +0,0 @@
-desc 'Download a diagram as an image to a file'
-arg_name 'diagram_id [diagram_id]*'
-command :get do |c|
-
-  c.desc 'Get a specific version number'
-  c.arg_name 'version_number'
-  c.default_value nil
-  c.flag [:v,:version]
-
-  c.desc 'Specify the filename'
-  c.arg_name 'filename'
-  c.default_value nil
-  c.flag [:f,:filename]
-
-  c.desc 'Specify the image type (one of jpeg, jpg, png, svg, xml)'
-  c.arg_name 'type'
-  c.default_value 'jpg'
-  c.flag [:t,:type,:"image-type"]
-
-  c.action do |global_options,options,args|
-
-    raise(UnknownArgumentException,'You must specify a diagram id') if args.length == 0
-    raise(MissingArgumentException,'You may not specify a filename when getting multiple diagrams') if args.length > 1 and options[:f]
-    args.each do |diagram_id|
-
-      version_number = options[:v]
-      filename = options[:f]
-      type = options[:t].to_sym
-      if !filename
-        dir = options['d'] || '.'
-        metadata = $gliffy.get_diagram_metadata(diagram_id)
-        filename = metadata.name.gsub(/[\s\/\-\+\$]/,'_')
-        if version_number
-          filename = "#{dir}/#{filename}_v#{version_number}.#{type.to_s}"
-        else
-          filename = "#{dir}/#{filename}.#{type.to_s}"
-        end
-      end
-
-      get_options = { :mime_type => type, :file => filename }
-      get_options[:version] = version_number if version_number
-      $gliffy.get_diagram_as_image(diagram_id,get_options)
-      puts filename
-    end
-  end
-end

data/lib/gliffy/commands/list.rb

@@ -1,27 +0,0 @@
-desc 'List all diagrams in the account'
-command [:list,:ls] do |c|
- 
-  c.desc 'List long form'
-  c.switch :l
-
-  c.action do |global_options,options,args|
-    diagrams = $gliffy.get_diagrams
-    if options[:l]
-      max = diagrams.inject(0) { |max,diagram| diagram.name.length > max ? diagram.name.length : max }
-      diagrams.sort.each do |diagram|
-        printf "%8d %s %-#{max}s %-3d %s  %s %s\n",
-        diagram.id,
-          diagram.is_public? ? "P" : "-",
-          diagram.name,
-          diagram.num_versions,
-          format_date(diagram.create_date),
-          format_date(diagram.mod_date),
-          diagram.owner_username
-      end
-    else
-      printf_string = "%d %s\n"
-      diagrams.sort.each { |diagram| printf printf_string,diagram.id,diagram.name }
-    end
-  end
-end
-

data/lib/gliffy/commands/new.rb

@@ -1,25 +0,0 @@
-desc 'Create a new diagram'
-arg_name 'new_diagram_name'
-command [:new,:create] do |c|
-  c.desc 'use the given diagram_id as a template'
-  c.default_value nil
-  c.flag [:t,:template]
-
-  c.desc 'don\'t edit the new diagram'
-  c.switch [:n,:"no-edit"]
-
-  c.action do |global_options,options,args|
-
-    raise(UnknownArgumentException,'You must specify the diagram name') if args.length != 1
-
-    template_id = options[:t]
-
-    diagram = $gliffy.create_diagram(args[0],template_id)
-    if options[:n]
-      puts "Diagram #{diagram.name} created with id #{diagram.id}"
-    else
-      GLI.run(['edit',diagram.id.to_s])
-    end
-  end
-end
-

data/lib/gliffy/commands/url.rb

@@ -1,21 +0,0 @@
-desc 'Get the URL for a diagram as an image image'
-arg_name 'diagram_id'
-command :url do |c|
-  c.desc 'Open URL with configured :open_url command'
-  c.switch [:o,:open]
-  c.action do |global_options,options,args|
-    raise UnknownArgumentException,"diagram id is required" if args.length == 0
-    raise UnknownArgumentException,"Only one diagram id is supported" if args.length > 1
-    url = $gliffy.get_diagram_as_url(args[0])
-    if options[:o]
-      if Gliffy::CLIConfig.instance.config[:open_image]
-        system(sprintf(Gliffy::CLIConfig.instance.config[:open_image],url))
-      else
-        puts "Nothing configured for #{:open_image.to_s} to open the image"
-        puts url
-      end
-    else
-      puts url
-    end
-  end
-end

data/lib/gliffy/config.rb

@@ -1,55 +0,0 @@
-require 'logger'
-
-module Gliffy
-
-  # Global Configuration for Gliffy.  This is a singleton currently and can be accessed
-  # via the config class method
-  # 
-  # * You mostly need to set api_key, secret_key and account_name
-  # * You may wish to set protocol if you have a premium account and wish to use https
-  class Config
-
-    # A Logger level to control logging
-    attr_accessor :log_level
-    # The log device (as passed to Logger) for where log messages should go
-    attr_accessor :log_device
-    # The protocol, either 'http' or 'https' (though feel free to try 'gopher:' :)
-    attr_accessor :protocol
-    # The gliffy app root, which is pretty much www.gliffy.com/gliffy unless you know a secret
-    attr_accessor :gliffy_app_root
-    # The url relative to gliffy_app_root of where the API is accessed
-    attr_accessor :gliffy_rest_context
-    # Your API Key
-    attr_accessor :api_key
-    # Your Secret Key
-    attr_accessor :secret_key
-    # The name of your account
-    attr_accessor :account_name
-
-    @@instance=nil
-
-    def initialize
-      @log_level = Logger::DEBUG
-      @log_device = STDERR
-      @protocol = 'http'
-      @gliffy_app_root = 'www.gliffy.com/gliffy';
-      @gliffy_rest_context = 'rest'
-      @api_key = 'no api key specified'
-      @secret_key = 'no secret key specified'
-      @account_name = 'no account name specified'
-    end
-
-    # Returns the entire URL to the gliffy api root.  This uses protocol, gliffy_app_root
-    # and gliffy_rest_context, so you should not really override this
-    def gliffy_root
-      "#{protocol}://#{gliffy_app_root}/#{gliffy_rest_context}"
-    end
-
-    def self.config=(config); @@instance = config; end
-    def self.config
-      @@instance = Config.new if !@@instance
-      @@instance
-    end
-  end
-end
-

data/lib/gliffy/diagram.rb

@@ -1,100 +0,0 @@
-require 'rexml/document'
-require 'array_has_response'
-require 'gliffy/rest'
-
-include REXML
-
-module Gliffy
-
-  # A gliffy diagram (or, rather, the meta data about that diagram)
-  class Diagram < Response
-
-    attr_reader :id
-    attr_reader :num_versions
-    attr_reader :name
-    # The username of the proper owner of this diagram
-    attr_reader :owner_username
-    # A Time representing the date on which this diagram was created
-    attr_reader :create_date
-    # A Time representing the date on which this diagram was last modified
-    attr_reader :mod_date
-    # A Time representing the date on which this diagram was published,
-    # or nil if it was not published
-    attr_reader :published_date
-
-    def self.from_xml(element)
-      id = element.attributes['id'].to_i
-      num_versions = element.attributes['num-versions'].to_i
-      is_private = element.attributes['is-private'] == "true"
-      is_public = element.attributes['is-public'] == "true"
-
-      create_date = Time.at(element.elements['create-date'].text.to_i / 1000)
-      mod_date = Time.at(element.elements['mod-date'].text.to_i / 1000)
-      published_date = element.elements['published-date'] ? Time.at(element.elements['published-date'].text.to_i / 1000) : nil
-      name = element.elements['name'].text
-      owner_username = element.elements['owner'] ? element.elements['owner'].text : nil
-
-      Diagram.new(id,name,owner_username,is_public,is_private,num_versions,create_date,mod_date,published_date)
-    end
-
-    # True if this diagram is public
-    def is_public?
-      @is_public
-    end
-
-    # True if this diagram is private (and available only
-    # to the owner and account administrators)
-    def is_private?
-      @is_private
-    end
-
-    # sorts by diagram name
-    def <=>(other_diagram)
-      name <=> other_diagram.name
-    end
-
-    protected 
-    def initialize(id,name,owner_username,is_public,is_private,num_versions,create_date,mod_date,published_date)
-      super()
-      @id = id
-      @name = name
-      @owner_username = owner_username
-      @is_public = is_public
-      @is_private = is_private
-      @num_versions = num_versions
-      @create_date = create_date
-      @mod_date = mod_date
-      @published_date = published_date
-    end
-
-  end
-
-  # A link to edit a specific gliffy diagram
-  class LaunchLink < Response
-
-    # The name of the diagram, which can helpful
-    # in creating HTML hyperlinks to url
-    attr_reader :diagram_name
-    attr_reader :url
-
-    def self.from_xml(element)
-      diagram_name = element.attributes['diagram-name']
-      url = element.text
-      LaunchLink.new(diagram_name,url)
-    end
-
-    def full_url
-      Gliffy::Config.config.protocol + "://" + Gliffy::Config.config.gliffy_app_root + url
-    end
-
-    protected
-
-    def initialize(name,url)
-      super()
-      @diagram_name = name
-      @url = url
-    end
-  end
-
-  class Diagrams < ArrayResponseParser; end
-end

data/lib/gliffy/folder.rb

@@ -1,63 +0,0 @@
-require 'rexml/document'
-require 'array_has_response'
-require 'gliffy/rest'
-
-include REXML
-
-module Gliffy
-
-  class Folders < ArrayResponseParser; end
-
-  class Folder < Response
-
-    # An array of Folder objects that are contained within this folder
-    # If this is empty, it means this Folder is a leaf
-    attr_reader :child_folders
-    attr_reader :id
-    attr_reader :name
-    # The full path to this folder within the account's 
-    # folder hierarchy
-    attr_reader :path
-
-    def self.from_xml(element)
-      id = element.attributes['id'].to_i
-      default = element.attributes['is-default'] == "true"
-      name = element.elements['name'].text
-      path = element.elements['path'].text
-      child_folders = Array.new
-      element.each_element do |element|
-        child_folders << Folder.from_xml(element) if element.name == "folder"
-      end
-      Folder.new(id,name,default,path,child_folders)
-    end
-
-    # Returns true if this folder is the default folder
-    # used when an operation requiring a folder
-    # doesn't specify one (such as when creating a new
-    # diagram)
-    def default?
-      @default
-    end
-
-    # Encodes the elements of a folder path so it can safely go into a URL
-    def self.encode_path_elements(folder_path)
-      encoded = ''
-      folder_path.split(/\//).each do |part|
-        encoded += CGI::escape(part)
-        encoded += "/"
-      end
-      encoded.gsub(/\/$/,'')
-    end
-
-    protected 
-
-    def initialize(id,name,default,path,child_folders)
-      super()
-      @id = id
-      @name = name
-      @default = default
-      @path = path
-      @child_folders = child_folders
-    end
-  end
-end

data/lib/gliffy/rest.rb

@@ -1,110 +0,0 @@
-require 'digest/md5'
-require 'cgi'
-require 'rubygems'
-require 'request_errors'
-require 'resource'
-require 'rest_client'
-
-require 'gliffy/config'
-require 'gliffy/url'
-
-require 'logger'
-
-module Gliffy
-
-  # Provides REST access to Gliffy, handling the signing of the requests
-  # but not the parsing of the results.  This class responds to the four primary HTTP methods:
-  #
-  # * get
-  # * put
-  # * post
-  # * delete
-  #
-  # Each method takes three parameters:
-  # [url] - the relative URL being requested
-  # [params] - a hash of parameters to include in the request (these are specific to the request, not things like apiKey or token)
-  # [headers] - any HTTP headers you want to set
-  #
-  # params and headers are optional.  These methods return whatever Gliffy sent back.  The context
-  # of the request should be used to determine the type, however it should be relatively safe to call
-  # Response#success? on whatever is returned to determine if everythign was OK
-  #
-  class Rest
-
-    # Provides access to the current token, 
-    # returning nil if none has been set
-    attr_accessor :current_token
-
-    # Provides access to the logger
-    # Do not set this to nil
-    attr_accessor :logger
-
-    attr_accessor :rest_client
-
-    # Create an accessor to the Gliffy REST api
-    #
-    def initialize
-      @current_token = nil
-      self.rest_client=RestClient
-      @logger = Logger.new(Config.config.log_device)
-      @logger.level = Config.config.log_level
-
-      @logger.debug("Creating #{self.class.to_s} with api_key of #{Config.config.api_key} against #{Config.config.gliffy_root}")
-    end
-
-    # Returns the complete URL that would be requested for
-    # the given URL and parameters
-    #
-    # [url] the URL, relative to the Gliffy API Root
-    # [params] a hash of parameters
-    #
-    def get_url(url,params=nil)
-      return create_url(url,params)
-    end
-
-    # Implements the http methods
-    def method_missing(symbol,*args)
-      if HTTP_METHODS[symbol]  && (args.length > 0)
-        url,params,headers = args
-        make_rest_request(symbol,url,params,headers)
-      else
-        if (HTTP_METHODS[symbol])
-          raise ArgumentError.new("Wrong number of arguments for method #{symbol.to_s}") 
-        else
-          super.method_missing(symbol,*args)
-        end
-      end
-    end
-
-    # Create the URL that would be needed to access the given resource with the given
-    # parameters
-    #
-    #   [+url+] url, relative to the gliffy root, to retrieve
-    #   [+params+] optional hash of parameters
-    #
-    def create_url(url,params=nil)
-      url = SignedURL.new(Config.config.api_key,Config.config.secret_key,Config.config.gliffy_root,url)
-      url.params=params if params
-      url['token'] = @current_token.token if @current_token
-
-      url.full_url
-    end
-
-    protected
-
-    def make_rest_request(method,url,params,headers)
-      headers = Hash.new if !headers
-      request_url = create_url(url,params)
-      @logger.debug("#{method.to_s.upcase} #{request_url}")
-      @rest_client.send(method,request_url,headers)
-    end
-
-    HTTP_METHODS = {
-      :get => true,
-      :put => true,
-      :delete => true,
-      :post => true,
-    };
-
-  end
-end