middleman-spreadsheet 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1259e8e1a1357c6e0a95455117be302b671576a5
-  data.tar.gz: 711cc54f680d3a22b7861a6afbccc457ccfa9e3e
+  metadata.gz: 51c67cf8110e3e5ecd9f70f0f6fe469b2a35647b
+  data.tar.gz: dfa4b6c549204b420277a1fb7d5fc8238a01d53a
 SHA512:
-  metadata.gz: 9fcd9eb87f0d5cd21a8a53cb81dc5c1ae70c9810f96cd257421fa98dbd4f445411c84d4952de7e9ec9f5fd793705e835695e76f7f746d24c2e07bee5b6ac72ef
-  data.tar.gz: fa3add330bc3a2d9a24b9fa8db8cd8fe100d4647b06eb379c1295870097338c2fc3dc12607c16e88f32908151dad790fa705af9746e870c8a962019013287d37
+  metadata.gz: e20a0a4f88458b71db63dc5a5f832c8e71429ff66e1ec1221991311b2c09e370f396c3960445f3d76495a13b8cc4583bf9a26dfd58c306b60655f540d20119ba
+  data.tar.gz: 617a29a065fed3a228ab3cec2303db9f0e269b561115e9627acd8572b4b829a4ff5743d791dc0a576a3fc05fcf30957fa38cf3b5631adf50a26692a39c77db70

data/README.md

@@ -0,0 +1,88 @@
+# middleman-spreadsheet
+
+Middleman extension for using Google spreadsheet as data files. Edit
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'middleman-spreadsheet'
+```
+
+And then execute:
+```
+$ bundle
+```
+
+## Setup
+
+1. Go to [Google API Console](https://console.developers.google.com/apis/credentials) and creates your own API credentials.
+2. Create google credentials json like
+```
+{
+ "client_id": "xxxxxxxxxxxx-xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx.apps.googleusercontent.com",
+ "client_secret": "xxxxxxxxxxxxxxxxxxxxxxxx"
+}
+```
+3. Activate `:spreadsheet` like below.
+```ruby
+activate :spreadsheet do |spreadsheet|
+  spreadsheet.config = "google_credentials.json"
+  spreadsheet.spreadsheet_url = "https://docs.google.com/spreadsheets/d/xxxxxxxxxxxxxxxxxxxxx/edit#gid=0"
+end
+```
+
+If you want to manage credentials without json, you could to use `spreadsheet.credentials` option.
+
+## Usage
+### Create spreadsheet
+Create spreadsheet.
+
+![](spreadsheet.png)
+
+### Specify spreadsheet
+You can specify spreadsheet by `spreadsheet_url`
+
+```ruby
+spreadsheet.spreadsheet_url = "https://docs.google.com/spreadsheets/d/xxxxxxxxxxxxxxxxxxxxx/edit#gid=0"
+```
+
+or `spreadsheet_key`
+
+```ruby
+spreadsheet.spreadsheet_key = "xxxxxxxxxxxxxxxxxxxxx"
+```
+ or `spreadsheet_title`.
+
+```ruby
+spreadsheet.spreadsheet_title = "foo bar sheet"
+```
+
+
+### Use in template
+You can use `data.spreadsheet.<worksheet_title>` like below.
+
+```haml
+%ul
+  - data.spreadsheet.Sheet1.each do |item|
+    %li #{item.id} #{item.foo} #{item.foo}
+```
+
+### Use in `config.rb`
+You can use `app.data.spreadsheet.<worksheet_title>` like below.
+
+```ruby
+app.data.spreadsheet.Sheet1.each do |row|
+  proxy "/foo/#{row.id}.html", "/items/show.html", locals: { foo: row }
+end
+```
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/hogelog/middlmean-spreadsheet.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/lib/middleman/spreadsheet/extension.rb

@@ -6,6 +6,7 @@ module Middleman
     class CredentialsNotFound < Exception; end
 
     class Extension < ::Middleman::Extension
+      option :config, nil, 'Google API credentials config json'
       option :credentials, nil, 'Google API credentials'
       option :data_name, "spreadsheet", 'Spreadsheet key'
       option :spreadsheet_key, nil, 'Spreadsheet key'

data/lib/middleman/spreadsheet/version.rb

@@ -1,5 +1,5 @@
 module Middleman
   module Spreadsheet
-    VERSION = "0.1.1"
+    VERSION = "0.1.2"
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: middleman-spreadsheet
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - hogelog
@@ -75,11 +75,13 @@ extra_rdoc_files: []
 files:
 - ".gitignore"
 - Gemfile
+- README.md
 - Rakefile
 - lib/middleman-spreadsheet.rb
 - lib/middleman/spreadsheet/extension.rb
 - lib/middleman/spreadsheet/version.rb
 - middleman-spreadsheet.gemspec
+- spreadsheet.png
 homepage: https://github.com/hogelog/sheet_wrap
 licenses:
 - MIT