hackpad-cli 0.0.7 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7daab4b137edd9a8b347ea91aa5f3b2b274d62cf
-  data.tar.gz: 0a6ea6f6ff546036118c9a92e5517e2f590e9c5f
+  metadata.gz: 75ec97eebdcae4ec244fa66f3275faa0b7f0db0c
+  data.tar.gz: 8190edde668cfaf92831a30ca7b5ce83d77228e3
 SHA512:
-  metadata.gz: 0888040ce658299976f0d38216665e7839df805a7c24e581cfce30623d91758d3243a275c9e84cb1f252e7c66e8e501132b709dd670ba942e98f5a560a9b1763
-  data.tar.gz: c5d33ee8c511411f82705a8e5a7c76f71956dffd7024f90388b3b99f7397b0c5ac1c90ecae7afd1fb56e90a647dde505d1bf38770f4b9db8518d2949bd53a252
+  metadata.gz: e44e5752085dc49e72dff125796dc0ece1b44538927020d092f032552c228d35d2dc3c301b79b6f2decc4eff6dc1d6cf50645745699770bde3be2c8810eb6198
+  data.tar.gz: 4b7d16c5a5bd6055cbbb291f6e8b7fc484cdafd2dfa996f52bae62443ec06b2ff5a140ca787daf7ba7539039f60a0b9b5b859c0647f95285b1d3a025f1258e33

data/.rubocop.yml

@@ -0,0 +1,14 @@
+LineLength:
+  Max: 122
+MethodLength:
+  Max: 16
+Documentation:
+  Enabled: false
+AlignHash:
+  Enabled: false
+IndentHash:
+  Enabled: false
+AlignParameters:
+  Enabled: false
+EmptyLinesAroundBody:
+  Enabled: false

data/.travis.yml

@@ -1,4 +1,5 @@
 language: ruby
+bundler_args: --path vendor
 cache: bundler
 rvm:
   - 1.9.3

data/CHANGELOG.md

@@ -1,21 +1,31 @@
 Hackpad-cli changelog
-==========================
+=====================
+
+v0.1.0 - 2014-05-17
+-------------------
+
+- add a `stats` command to show how much pads are cached, and when it was last refreshed
+- move `-r` (refresh) and `-u` (urls) options to specific method options
+- add a User-Agent so that hackpad knows what is poking them
+- completed test coverage
+- prevent trailing slash on site config param to fuck up urls
+- useless but satisfying rubocop green flag
 
 v0.0.7 - 2014-05-15
--------------
+-------------------
 
 - add a `cached_at` value in metadata, visible in the `show` command
 - fix `info` to display guest policy properly
-- add a `check` command to check if there are new pads and dcide to refresh or not
+- add a `check` command to check if there are new pads and decide to refresh or not
 - whole lot of more tests
 
 v0.0.6 - 2014-05-04
-------------
+-------------------
 
 - fix compat with 1.9.3 (require ostruct)
 
 v0.0.5 - 2014-05-04
---------------------
+-------------------
 
 - add a dot-timer for when padlist refreshes so one knows that something is happening
 - add an option `-u` to display urls rather than pad id
@@ -25,13 +35,13 @@ v0.0.5 - 2014-05-04
 - add a flag for removing colors `-p`
 
 v0.0.4 - 2014-05-01
---------------------
+-------------------
 
 - add options in pad info for `hpcli info [pad_id]`
 - implement a search command `hpcli search [term]`
 
 v0.0.3 - 2014-05-01
---------------
+-------------------
 
 - add a better way to manage alternative configuration file
 - fix alternate config dir setup
@@ -39,11 +49,11 @@ v0.0.3 - 2014-05-01
 - better readme
 
 v0.0.2 - 2014-05-01
----------------
+-------------------
 
 - damn, forgot to remove awesome_print. huhu
 
 v0.0.1 - 2014-05-01
-------------------------
+-------------------
 
 - initial release of a draft

data/README.md

@@ -33,6 +33,8 @@ or
     cd hackpad-cli
     bundle install
 
+Then you will have to launch it once and it will ask you some questions. you can find your client_id and secret at https://<subdomain>.hackpad.com/ep/account/settings/ (your subdomain is where you store the pads).
+
 Usage
 ---------------
 
@@ -40,22 +42,21 @@ Usage
 
 ```
 Commands:
-  hpcli check                   # Checks differences between local cache and remote list.
+  hpcli check                   # Checks differences between local cache and remote list (options: -u to show urls).
   hpcli help [COMMAND]          # Describe available commands or one specific command
   hpcli info [pad_id]           # gets info for the pad <pad_id>.
-  hpcli list                    # Lists available pads.
-  hpcli search [term]           # Lists available pads matching [term].
-  hpcli show [pad_id] [format]  # shows pad <pad_id> in format [html,txt,md] (default txt).
+  hpcli list                    # Lists available pads (options: -u to show urls, -r to refresh).
+  hpcli search [term]           # Lists available pads matching [term] (options: -u to show urls)
+  hpcli show [pad_id] [format]  # shows pad <pad_id> in format [html,txt,md] (default txt) (options: -r to refresh).
+  hpcli stats                   # Lists configuration values.
   hpcli version                 # Displays the hackpad-cli version.
 
 Options:
-  -c, [--configdir=CONFIGDIR]      # Path to the hackpad-cli directory to use.
-                                   # Default: /home/mose/.hackpad-cli/
-  -w, [--workspace=WORKSPACE]      # Name of the workspace to use.
-                                   # Default: default
-  -r, [--refresh], [--no-refresh]  # Add this if you want refresh the cache.
-  -u, [--urls], [--no-urls]        # Displays urls rather than pad ids.
-  -p, [--plain], [--no-plain]      # Add this if you don't want colors.
+  -c, [--configdir=CONFIGDIR]  # Path to the hackpad-cli directory to use.
+                               # Default: /home/mose/.hackpad-cli/
+  -w, [--workspace=WORKSPACE]  # Name of the workspace to use.
+                               # Default: default
+  -p, [--plain], [--no-plain]  # Add this if you don't want colors.
 ```
 
 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.
@@ -66,12 +67,12 @@ Roadmap and todoz
 
 Check the [Changelog](CHANGELOG.md) for past evolutions.
 
-- for v0.1.0
+- <s>for v0.1.0</s>
   - <s>add freaking cool badges on the readme</s>
   - <s>cache the pads list in a local storage</s>
   - <s>have a choice to refresh cache</s>
   - <s>display cached date in output</s>
-  - write proper tests
+  - <s>write proper tests</s>
 - for v0.2.0
   - add commands for creating a new pad, linked to $EDITOR
   - add a gateway to github so a pad could be copied over a wiki page directly or in a repo somehow

data/Rakefile

@@ -5,16 +5,16 @@ rescue LoadError
   puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
 end
 require 'bundler/setup'
-require "bundler/gem_tasks"
-require "rake/testtask"
-require "rspec/core/rake_task" # RSpec 2.0
+require 'bundler/gem_tasks'
+require 'rake/testtask'
+require 'rspec/core/rake_task' # RSpec 2.0
 
-desc "launch rspec tests"
+desc 'launch rspec tests'
 task :spec do
   RSpec::Core::RakeTask.new(:spec) do |t|
-    t.rspec_opts = ["-c", "-f progress", "-r ./spec/spec_helper.rb"]
+    t.rspec_opts = ['-c', '-f progress', '-r ./spec/spec_helper.rb']
     t.pattern = 'spec/lib/**/*_spec.rb'
   end
 end
 
-task :default => :spec
+task default: :spec

data/bin/hpcli

@@ -1,5 +1,5 @@
 #!/usr/bin/env ruby
 
-require_relative "../lib/hackpad/cli/runner"
+require_relative '../lib/hackpad/cli/runner'
 
 Hackpad::Cli::Runner.start

data/hackpad-cli.gemspec

@@ -4,29 +4,29 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'hackpad/cli/version'
 
 Gem::Specification.new do |spec|
-  spec.name          = "hackpad-cli"
+  spec.name          = 'hackpad-cli'
   spec.version       = Hackpad::Cli::VERSION
-  spec.authors       = ["mose"]
-  spec.email         = ["mose@mose.com"]
-  spec.summary       = %q{CLI for hackpad browsing and editing.}
-  spec.description   = %q{A Command Line Interface for consuming the Hackpad REST API.}
-  spec.homepage      = "https://github.com/mose/hackpad-cli"
-  spec.license       = "MIT"
+  spec.authors       = ['mose']
+  spec.email         = ['mose@mose.com']
+  spec.summary       = %q(CLI for hackpad browsing and editing.)
+  spec.description   = %q(A Command Line Interface for consuming the Hackpad REST API.)
+  spec.homepage      = 'https://github.com/mose/hackpad-cli'
+  spec.license       = 'MIT'
 
   spec.files         = `git ls-files -z`.split("\x0")
-  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
-  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
-  spec.require_paths = ["lib"]
+  spec.executables   = spec.files.grep(/^bin\//) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(/^spec\//)
+  spec.require_paths = ['lib']
 
-  spec.add_dependency "thor"
-  spec.add_dependency "colorize"
-  spec.add_dependency "oauth"
-  spec.add_dependency "reverse_markdown"
+  spec.add_dependency 'thor'
+  spec.add_dependency 'colorize'
+  spec.add_dependency 'oauth'
+  spec.add_dependency 'reverse_markdown'
 
-  spec.add_development_dependency "bundler", "~> 1.5"
-  spec.add_development_dependency "rake"
-  spec.add_development_dependency "rspec"
-  spec.add_development_dependency "webmock"
-  spec.add_development_dependency "coveralls"
-  spec.add_development_dependency "codeclimate-test-reporter"
+  spec.add_development_dependency 'bundler', '~> 1.5'
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'rspec'
+  spec.add_development_dependency 'webmock'
+  spec.add_development_dependency 'coveralls'
+  spec.add_development_dependency 'codeclimate-test-reporter'
 end

data/lib/hackpad/cli/api.rb

@@ -9,10 +9,9 @@ module Hackpad
     end
 
     module Api
-      extend self
+      module_function
 
       def prepare(config)
-        site = URI.parse config['site']
         consumer = OAuth::Consumer.new(
           config['client_id'],
           config['secret'],
@@ -21,16 +20,12 @@ module Hackpad
         @token = OAuth::AccessToken.new consumer
       end
 
-      def search(term, start=0)
+      def search(term, start = 0)
         get "/api/1.0/search?q=#{CGI.escape term}&start=#{start}&limit=100"
       end
 
       def list
-        get "/api/1.0/pads/all"
-      end
-
-      def title(id)
-        show(id, 'txt').lines.first
+        get '/api/1.0/pads/all'
       end
 
       def read_options(id)
@@ -41,17 +36,12 @@ module Hackpad
         get "/api/1.0/pad/#{id}/content.#{ext}", false
       end
 
-      def get(url, json=true)
-        res = @token.get url
+      def get(url, json = true)
+        res = @token.get url, 'User-Agent' => "hackpad-cli v#{Hackpad::Cli::VERSION}"
         if res.is_a? Net::HTTPSuccess
-          puts res.body.inspect if ENV['DEBUG']
-          if json
-            JSON.parse res.body
-          else
-            res.body
-          end
+          json ? JSON.parse(res.body) : res.body
         else
-          raise ApiException, "HTTP error, code #{res.code}"
+          fail ApiException, "HTTP error, code #{res.code}"
         end
       end
 

data/lib/hackpad/cli/client.rb

@@ -11,7 +11,7 @@ module Hackpad
   module Cli
     class Client
 
-      def initialize(options, output=STDOUT)
+      def initialize(options, output = STDOUT)
         @output = output
         @options = options
         Store.prepare @options
@@ -22,11 +22,16 @@ module Hackpad
         end
       end
 
-      # GET /api/1.0/pads/all
-      def search(term,start=0)
-        payload = Api.search(term,start)
+      def stats
+        table 'Site', @config['site'].blue
+        table 'Cached Pads', Store.count_pads
+        table 'Last Refresh', Store.last_refresh || 'not refreshed yet'
+      end
+
+      def search(term, start = 0)
+        payload = Api.search(term, start)
         payload.each do |a|
-          @output.puts "#{(@config['site'] + '/') if @options[:urls]}#{a['id'].bold} - #{unescape(a['title']).yellow}"
+          @output.puts "#{id_or_url a['id']} - #{unescape(a['title']).yellow}"
           @output.puts "   #{extract a['snippet']}"
         end
       end
@@ -38,10 +43,10 @@ module Hackpad
       end
 
       def check
-        @output.puts "New pads:"
-        padlist = Padlist.check_list.map
+        @output.puts 'New pads:'
+        padlist = Padlist.check_list(@options['refresh']).map
         if padlist.count == 0
-          @output.puts "There is no new pad."
+          @output.puts 'There is no new pad.'
         else
           @output.puts padlist.map { |pad|
             padline pad
@@ -52,17 +57,17 @@ module Hackpad
       def info(id)
         pad = Pad.new id
         pad.load 'txt'
-        table "Id", "#{id}".bold
-        table "Title", "#{pad.title}".yellow
-        table "URI", "#{@config['site']}/#{id}"
-        table "Chars", "#{pad.chars}"
-        table "Lines", "#{pad.lines}"
-        table "Guest Policy", "#{pad.guest_policy}"
-        table "Moderated", "#{pad.moderated}"
-        table "Cached", "#{pad.cached_at || 'unknown'}"
+        table 'Id', "#{id}".bold
+        table 'Title', "#{pad.title}".yellow
+        table 'URI', "#{@config['site']}/#{id}"
+        table 'Chars', "#{pad.chars}"
+        table 'Lines', "#{pad.lines}"
+        table 'Guest Policy', "#{pad.guest_policy}"
+        table 'Moderated', "#{pad.moderated}"
+        table 'Cached', "#{pad.cached_at || 'unknown'}"
       end
 
-      def show(id,format)
+      def show(id, format)
         ext = (format == 'md') ? 'html' : format
         pad = Pad.new id
         pad.load ext
@@ -73,7 +78,7 @@ module Hackpad
         end
       end
 
-    private
+      private
 
       def padline(pad)
         "#{(@config['site'] + '/') if @options[:urls]}#{pad.id} - #{pad.title}"
@@ -84,13 +89,17 @@ module Hackpad
       end
 
       def extract(s)
-        unescape(s).gsub(/<b class="hit">([^<]*)<\/b>/) { |e| $1.cyan.bold }
+        unescape(s).gsub(/<b class="hit">([^<]*)<\/b>/) { Regexp.last_match[1].cyan.bold }
       end
 
-      def table(key,value)
+      def table(key, value)
         @output.printf "%-20s %s\n", key, value
       end
 
+      def id_or_url(id)
+        "#{(@config['site'] + '/') if @options[:urls]}#{id.bold}"
+      end
+
     end
   end
 end

data/lib/hackpad/cli/config.rb

@@ -3,44 +3,39 @@ require 'colorize'
 module Hackpad
   module Cli
     module Config
-      extend self
+      module_function
 
-      def load(options, input=STDIN, output=STDOUT)
+      def load(options, input = STDIN, output = STDOUT)
         @input = input
         @output = output
         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
-        if !Dir.exists?(configdir) || !File.exists?(configfile)
+        if !Dir.exist?(configdir) || !File.exist?(configfile)
           setup configfile, input, output
         end
-        YAML::load_file configfile
+        YAML.load_file configfile
       end
 
-    private
-
-      def setup(configfile, input=STDIN, output=STDOUT)
+      def setup(configfile, input = STDIN, output = STDOUT)
         config = {}
         FileUtils.mkdir_p File.dirname(configfile)
-        output.puts "We need first to initialize your hackpad-cli configuration.".blue
-        output.puts "Please gather your information from https://<subdomain>.hackpad.com/ep/account/settings/".light_blue
-        output.print "What is your Client ID?  "
-        config['client_id'] = input.gets.chomp
-        output.flush
-        output.print "What is your Secret Key? "
-        output.flush
-        config['secret'] = input.gets.chomp
-        output.print "What is the URI of your pad? "
-        output.flush
-        config['site'] = input.gets.chomp
-        File.open(configfile, "w") do |f|
-          f.write YAML::dump(config)
+        output.puts 'We need first to initialize your hackpad-cli configuration.'.blue
+        output.puts 'Please gather your information from https://<subdomain>.hackpad.com/ep/account/settings/'.light_blue
+        config['client_id'] = ask 'What is your Client ID?', input, output
+        config['secret'] = ask 'What is your Secret Key?', input, output
+        config['site'] = ask('What is the URI of your pad?', input, output).gsub(/\/$/, '')
+        File.open(configfile, 'w') do |f|
+          f.write YAML.dump(config)
         end
       end
 
+      def ask(question, input, output)
+        output.print "#{question} "
+        back = input.gets.chomp
+        output.flush
+        back
+      end
+
     end
   end
 end