drumknott 0.1.1 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: dc46dbcdf65393aaf4af4a5dc577c6adc135a969
-  data.tar.gz: f097fd31a67193b6d7e4061c945114cfc959348e
+  metadata.gz: d8212f93f568255ff2ecd7e0f72b52682ad63c28
+  data.tar.gz: 8e3435731be5c384b1bd9c62516909e38a2f428d
 SHA512:
-  metadata.gz: 710b67e0e866939d75ced56247cbf0d2ab2690e9d032bf494a893d0494d030c2c40db4cff85aa191b64e2b24ee68fd3811f7c92ff4189760ce010ff0f4771af9
-  data.tar.gz: 2e2c1e6a77f8df3dd73795cd4fcc53855b1ee7a103a4ca1faf8534ac9a3cbe0fd116299be9ec0cc23719953b0344ddc5881f46fd5b0d5636f39886d8170680b0
+  metadata.gz: 41e3d9bacfdee43bc3c3c17c02b4eb6eecc4f08ccd3efe7c8ab55a6ae7770fe97d10e27a79696c5a3fbabf874a48ca0886974ddddb4990f5c17e920561af1899
+  data.tar.gz: b838d47ff33dd8af2111c4b0db26825a2316202a68da5adb4a184d675c838d7b86acdf959900825ecf1b373cc42fd0fe733e63b3588e122c6a031fdb2099e656

data/README.md

@@ -10,11 +10,13 @@ Command line tool for the Drumknott search service. When invoked, it takes each
 
 From within the local Jekyll site directory, using the credentials provided by Drumknott:
 
-    $ drumknott keys SITE_NAME SITE_KEY
+    $ drumknott keys SITE_NAME SITE_KEY INCLUDE_PAGES
     $ drumknott refresh
 
 The `keys` command will save your credentials to a `.drumknott` file in your site's directory. Do not commit this file to git! If you don't want to have that file saved, you can alternatively use the environment variables `DRUMKNOTT_NAME` and `DRUMKNOTT_KEY` respectively.
 
+By default, both posts and normal pages will be uploaded to Drumknott. If you only wish to include posts, the INCLUDE_PAGES argument in the `keys` command should be `'no'`. This can also be managed via the `DRUMKNOTT_PAGES` environment variable.
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `bin/console` for an interactive prompt that will allow you to experiment.
@@ -31,5 +33,5 @@ Firstly, please note the Code of Conduct for all contributions to this project.
 
 ## Licence
 
-Copyright (c) 2015, Drumknott is developed and maintained by Pat Allan, and is
+Copyright (c) 2016, Drumknott is developed and maintained by Pat Allan, and is
 released under the open MIT Licence.

data/drumknott.gemspec

@@ -1,7 +1,7 @@
 # coding: utf-8
 Gem::Specification.new do |spec|
   spec.name          = "drumknott"
-  spec.version       = "0.1.1"
+  spec.version       = "0.2.0"
   spec.authors       = ["Pat Allan"]
   spec.email         = ["pat@freelancing-gods.com"]
 
@@ -17,7 +17,7 @@ Gem::Specification.new do |spec|
 
   spec.add_runtime_dependency 'faraday'
   spec.add_runtime_dependency 'json'
-  spec.add_runtime_dependency 'jekyll'
+  spec.add_runtime_dependency 'jekyll', '>= 3.0'
 
   spec.add_development_dependency 'rspec'
   spec.add_development_dependency 'webmock'

data/lib/drumknott.rb

@@ -7,5 +7,6 @@ module Drumknott
 end
 
 require 'drumknott/cli'
+require 'drumknott/include_pages'
 require 'drumknott/keys'
 require 'drumknott/refresh'

data/lib/drumknott/cli.rb

@@ -1,18 +1,19 @@
 class Drumknott::CLI
   EMPTY_CACHE = {}.freeze
 
-  def self.call(command, arguments = [], name = nil, key = nil)
-    new(command, arguments, name, key).call
+  def self.call(command, arguments = [], name = nil, key = nil, include_pages = nil)
+    new(command, arguments, name, key, include_pages).call
   end
 
-  def initialize(command, arguments = [], name = nil, key = nil)
-    @command, @arguments, @name, @key = command, arguments, name, key
+  def initialize(command, arguments = [], name = nil, key = nil, include_pages = nil)
+    @command, @arguments, @name, @key, @include_pages =
+      command, arguments, name, key, include_pages
   end
 
   def call
     case command
     when 'refresh'
-      Drumknott::Refresh.call name, key
+      Drumknott::Refresh.call name, key, include_pages?
     when 'keys'
       Drumknott::Keys.call arguments
     else
@@ -53,4 +54,11 @@ Credentials for Drumknott are expected via environment variables, or via a
   def key
     @key || cache['key'] || ENV['DRUMKNOTT_KEY']
   end
+
+  def include_pages?
+    return @include_pages unless @include_pages.nil?
+    return cache['pages'] unless cache['pages'].nil?
+
+    Drumknott::IncludePages.call ENV['DRUMKNOTT_PAGES']
+  end
 end

data/lib/drumknott/include_pages.rb

@@ -0,0 +1,12 @@
+class Drumknott::IncludePages
+  TRUE_OPTIONS = ['true', 'yes', 'y'].freeze
+
+  def self.call(value)
+    case value
+    when TrueClass, FalseClass
+      value
+    else
+      value.nil? || TRUE_OPTIONS.include?(value.downcase)
+    end
+  end
+end

data/lib/drumknott/keys.rb

@@ -4,17 +4,18 @@ class Drumknott::Keys
   end
 
   def initialize(arguments)
-    @name, @key, ignored = *arguments
+    @name, @key, @pages, ignored = *arguments
   end
 
   def call
     File.write '.drumknott', JSON.generate(
-      'name' => name,
-      'key'  => key
+      'name'  => name,
+      'key'   => key,
+      'pages' => Drumknott::IncludePages.call(pages)
     )
   end
 
   private
 
-  attr_reader :name, :key
+  attr_reader :name, :key, :pages
 end

data/lib/drumknott/refresh.rb

@@ -1,12 +1,12 @@
 class Drumknott::Refresh
   URL = 'https://drumknottsearch.com'
 
-  def self.call(name, key)
-    new(name, key).call
+  def self.call(name, key, include_pages = true)
+    new(name, key, include_pages).call
   end
 
-  def initialize(name, key)
-    @name, @key = name, key
+  def initialize(name, key, include_pages)
+    @name, @key, @include_pages = name, key, include_pages
   end
 
   def call
@@ -34,26 +34,33 @@ class Drumknott::Refresh
     end
   end
 
+  def include_pages?
+    @include_pages
+  end
+
   def site
     @site ||= Jekyll::Site.new Jekyll.configuration
   end
 
   def update
-    site.posts.each do |page|
-      connection.put do |request|
-        request.url "/api/v1/#{name}/pages"
-
-        request.headers['AUTHENTICATION'] = key
-        request.headers['Content-Type']   = 'application/json'
-
-        request.body = JSON.generate({
-          :page => {
-            :name    => page.title,
-            :path    => page.url,
-            :content => page.output
-          }
-        })
-      end
+    site.posts.docs.each { |document| update_document document }
+    site.pages.each      { |page|     update_document page } if include_pages?
+  end
+
+  def update_document(document)
+    connection.put do |request|
+      request.url "/api/v1/#{name}/pages"
+
+      request.headers['AUTHENTICATION'] = key
+      request.headers['Content-Type']   = 'application/json'
+
+      request.body = JSON.generate({
+        :page => {
+          :name    => document.data['title'],
+          :path    => document.url,
+          :content => document.output
+        }
+      })
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: drumknott
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0
 platform: ruby
 authors:
 - Pat Allan
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2015-09-27 00:00:00.000000000 Z
+date: 2016-02-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -44,14 +44,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '3.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '3.0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -101,6 +101,7 @@ files:
 - exe/drumknott
 - lib/drumknott.rb
 - lib/drumknott/cli.rb
+- lib/drumknott/include_pages.rb
 - lib/drumknott/keys.rb
 - lib/drumknott/refresh.rb
 homepage: https://github.com/pat/drumknott
@@ -128,3 +129,4 @@ signing_key:
 specification_version: 4
 summary: Jekyll content uploader for Drumknott's search service.
 test_files: []
+has_rdoc: