hackpad-cli 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 46ab66a97de8e3e75f8c311b9de5917ad4ee0c1f
-  data.tar.gz: 14ca15ac7767e4eb7935d88695d3add33dac8d97
+  metadata.gz: fb2500eed443d5bc32fb2c6a1c0fdbd85095037a
+  data.tar.gz: af50106dab8686626a27c6bba5085a6211717773
 SHA512:
-  metadata.gz: c1cac457c93a5229dc4e4c1a9da29a6a53ecd612553150cc09d28ed9185bff673c7ad54a4bafc92b0f8b6b186d6d20f07edfc517a814bbbdabf436862f948d53
-  data.tar.gz: 3dcde9a5fdbdb3679b7465f1e8831903a87c09498cba23a6197e625af8583ee9e304f29c3e6df8493fc756dbdb236e703a482589205dfbcb3a511ff21e900e02
+  metadata.gz: 3531001771b33e3e8eeffee112b7e1f0075fabc32c6e10281c6b2df9eb81a7a30df2d0d51e7190f029f6aff51d8cc4b97fa47de8180cc35ae162a34b76b442dd
+  data.tar.gz: 93f097d8ded9f2a4e45cf9e5f914d14a116f9950e32b90daa832553d38829b2fba1aa2bbe50a113d2135a03aa031723c0bc832ddff2126fcb6eb067784a7c91b

data/CHANGELOG.md

@@ -1,6 +1,14 @@
 Hackpad-cli changelog
 ==========================
 
+v0.0.3 - 2014-04-01
+--------------
+
+* add a better way to manage alternative configuration file
+* fix alternate config dir setup
+* verify compat with ruby 1.9.3
+* better readme
+
 v0.0.2 - 2014-04-01
 ---------------
 

data/README.md

@@ -2,9 +2,10 @@ Hackpad-Cli
 ===================
 
 This is a command-line utility to check and manipulate hackpad documents.
-It uses Hackpad REST API 1.0 https://hackpad.com/fQD2DRz22Wf
+It uses Hackpad REST API 1.0 https://hackpad.com/fQD2DRz22Wf and was tested with ruby 1.9.3 and 2.1.1.
 
-Initially this tool was created to overcome the frustration of the md export of pads, becasue we need to copy them to other places sometimes where proper markdown would be appreciated.
+Initially this tool was created to overcome the frustration of the md export of pads,
+because we need to copy them to other places sometimes. Proper markdown would be appreciated.
 
 So for now, it does that, by transforming the html in markdown with the https://github.com/xijo/reverse_markdown gem.
 
@@ -24,9 +25,27 @@ Usage
 
 (use `bundle exec` if you need, mostly in clone mode when not using rvm)
 
-    hpcli # will show help
+    hpcli                 # will show help
+    hpcli list            # gets a list of pads you have access to
     hpcli get <pad_id> md # will spit out the content in nice markdown
+    # and you can use alternate config
+    hpcli list -w alt
 
+At first launch it will create your config dir (default ~/.hackpad-cli/), and will ask you questions to create the config file (default is .. default.yml). If you pass the `-w whatever` option at the end, it will ask questions again to write whatever.yml config file.
+
+
+Roadmap and todoz
+---------------------
+
+* cache the pads list in a local storage
+* refresh cache according to last cached date
+* add commands for creating a new pad, linked to $EDITOR
+* add admin commands for managing users
+* nag hackpad for they add REST endpoints to query collections
+* write proper tests
+* add freaking cool badges on the readme
+* add a gateway to github so a pad could be copied over a wiki page directly or in a repo somehow
+* implement pretty much all what the hackpad API v1 offers
 
 Contributing
 ------------------

data/lib/hackpad/cli.rb

@@ -6,29 +6,32 @@ require_relative "client"
 module Hackpad
 
   class Cli < Thor
-    include Thor::Actions
-
-    default_task :help
 
     class_option :configdir,
       aliases: "-c",
-      banner: "PATH",
       default: File.join(ENV["HOME"], ".hackpad-cli/"),
-      desc: "Path to the hackpad-cli directory to use"
+      desc: "Path to the hackpad-cli directory to use."
+
+    class_option :workspace,
+      aliases: "-w",
+      default: "default",
+      desc: "Name of the workspace to use."
+
+    default_task :help
 
     desc "list", "Lists available pads."
     def list
-      Hackpad::Client.new(options[:configdir]).list
+      Hackpad::Client.new(options).listall
     end
 
-    desc "getinfo [pad_id]", "gets info for the pad <pad_id>"
+    desc "getinfo [pad_id]", "gets info for the pad <pad_id>."
     def getinfo(pad)
-      Hackpad::Client.new(options[:configdir]).getinfo pad
+      Hackpad::Client.new(options).getinfo pad
     end
 
-    desc "show [pad_id] [format]", "shows pad <pad_id> in format [html,txt,md] (default txt)"
+    desc "show [pad_id] [format]", "shows pad <pad_id> in format [html,txt,md] (default txt)."
     def show(pad,format='txt')
-      Hackpad::Client.new(options[:configdir]).show pad, format
+      Hackpad::Client.new(options).show pad, format
     end
 
   end

data/lib/hackpad/cli/version.rb

@@ -2,6 +2,6 @@ require "thor"
 
 module Hackpad
   class Cli < Thor
-    VERSION = "0.0.2"
+    VERSION = "0.0.3"
   end
 end

data/lib/hackpad/client.rb

@@ -8,9 +8,8 @@ require_relative 'config'
 module Hackpad
   class Client
 
-    def initialize(configdir)
-      @configdir = configdir
-      @config = Config.load configdir
+    def initialize(options)
+      @config = Config.load options
       site = URI.parse @config['site']
       consumer = OAuth::Consumer.new(
         @config['client_id'],
@@ -21,12 +20,12 @@ module Hackpad
     end
 
     # GET /api/1.0/pads/all
-    def list
+    def listall
       res = @token.get "/api/1.0/pads/all"
       if res.is_a? Net::HTTPSuccess
         all = JSON.parse res.body
         all.each do |a|
-          puts getinfo(a)
+          getinfo(a)
         end
       else
         puts "#{res.inspect}".colorize :red
@@ -38,7 +37,7 @@ module Hackpad
     def getinfo(pad)
       res = @token.get "/api/1.0/pad/#{pad}/content.txt"
       if res.is_a? Net::HTTPSuccess
-        puts "#{@config['site']}/#{pad} - #{res.body.lines.first.chomp}"
+        puts "#{@config['site']}/#{pad} - #{pad} - #{res.body.lines.first.chomp}"
       else
         puts "#{pad} failed".colorize :red
       end

data/lib/hackpad/config.rb

@@ -2,18 +2,24 @@ module Hackpad
   module Config
     extend self
 
-    def load(dir = nil)
-      if !Dir.exists?(conf_dir dir) || !File.exists?(conf_file)
-        setup conf_dir dir
+    def load(options)
+      configdir = options[:configdir]
+      configfile = File.join(configdir, "#{options[:workspace]}.yml")
+      # temporary migration path
+      if !File.exists?(configfile) && File.exists?(File.join(configdir, "config.yml"))
+        FileUtils.mv File.join(configdir, "config.yml"), configfile
       end
-      YAML::load_file conf_file
+      if !Dir.exists?(configdir) || !File.exists?(configfile)
+        setup configfile
+      end
+      YAML::load_file configfile
     end
 
   private
 
-    def setup(dir)
+    def setup(configfile)
       config = {}
-      FileUtils.mkdir_p dir
+      FileUtils.mkdir_p File.dirname(configfile)
       puts "We need first to initialize your hackpad-cli configuration.".colorize(:blue)
       puts "Please gather your information from https://<subdomain>.hackpad.com/ep/account/settings/"
       print "What is your Client ID?  "
@@ -25,18 +31,10 @@ module Hackpad
       print "What is the URI of your pad? "
       STDOUT.flush
       config['site'] = STDIN.gets.chomp
-      File.open(conf_file, "w") do |f|
+      File.open(configfile, "w") do |f|
         f.write YAML::dump(config)
       end
     end
 
-    def conf_file
-      File.join(conf_dir, 'config.yml')
-    end
-
-    def conf_dir(dir = "#{ENV["HOME"]}/.hackpad-cli/")
-      dir
-    end
-
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: hackpad-cli
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - mose