carraway 0.9.0 → 0.10.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2fa7bf196fef42d4f8131df73bcec5885b3fd0501603495c9e60fde6ca94f288
-  data.tar.gz: da4a03acb56e94e169463ade2399f8163afa03afa8333d0282b7c28a4012c75b
+  metadata.gz: d415ec6e6ae471fa9ae3efa61f5def1465f9ee389f4493c79fa9346b6a48403f
+  data.tar.gz: afbdce1993f0df85e123a52c700b9752ddc211a294a49ec79e25db4450dcd1f4
 SHA512:
-  metadata.gz: dbb157533c82f9cb6b4e18eb713b34f658a879785ecdac0c26aad5830981808c550dee0e0cda5477f26e60eaf0b371852eed4ea6561e4ba5849430034720cb7d
-  data.tar.gz: ee328b4c377160bd03d81314279fff864dbd524164e2d887415b86d32ba91340a403b305acb39a8be11e022275c7661d93a60fc55f6b226fafef387e7de94baa
+  metadata.gz: 54455684723a8cf69b68c04625340d84efe035fd2787d3b5d36fd971ec23b9b97b30f6909cc97f83c690343848805d613c6b2f0527bcb1a27435580e0d0fbe14
+  data.tar.gz: be647d4c395a25a290ae1c93d12f9d5ff0b72aabe379ce609dcaa94b035d200552fcb157cc242f1758099a1c69bcd6c4b35717b744bc4af0b6041187b48c34f8

data/.travis.yml

@@ -1,5 +1,17 @@
 sudo: false
 language: ruby
 rvm:
-  - 2.4.1
-before_install: gem install bundler -v 1.16.1
+  - 2.5
+  - 2.6
+env:
+  global:
+    - CC_TEST_REPORTER_ID=6163381913794d34d745b65d61b589c603cda50fb74c94a54ab0c6305c249bc3
+before_install:
+  - gem install bundler -v 1.16.2
+  - docker-compose -f docker/docker-compose.yml up -d
+before_script:
+  - curl -L https://codeclimate.com/downloads/test-reporter/test-reporter-latest-linux-amd64 > ./cc-test-reporter
+  - chmod +x ./cc-test-reporter
+  - ./cc-test-reporter before-build
+after_script:
+  - ./cc-test-reporter after-build --exit-code $TRAVIS_TEST_RESULT

data/README.md

@@ -1,8 +1,15 @@
-# Carraway
+# Carraway [![Build Status](https://travis-ci.org/adorechic/carraway.svg?branch=master)](https://travis-ci.org/adorechic/carraway) [![Maintainability](https://api.codeclimate.com/v1/badges/0c6800daedd07274f11c/maintainability)](https://codeclimate.com/github/adorechic/carraway/maintainability) [![Test Coverage](https://api.codeclimate.com/v1/badges/0c6800daedd07274f11c/test_coverage)](https://codeclimate.com/github/adorechic/carraway/test_coverage)
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/carraway`. To experiment with that code, run `bin/console` for an interactive prompt.
+Carraway is a lightweight CMS backend for [Gatsby](https://www.gatsbyjs.org/).
 
-TODO: Delete this and the text above, and describe your gem
+Carraway provides
+- Web console to edit contents
+- Web preview for contents on Gatsby
+- REST API for Gatsby to integrate with Carraway
+
+[gatsby-source-carraway](https://github.com/adorechic/gatsby-source-carraway) is a source plugin for Gatsby to integrate with Carraway.
+
+Carraway is required on Gatsby build and contents editting, so you don't have to keep running Carraway process.
 
 ## Installation
 
@@ -21,11 +28,62 @@ Or install it yourself as:
     $ gem install carraway
 
 ## Usage
+Put carraway.yml
+
+```yaml
+backend:
+  table_name: 'carraway_table' # If you use DynamoDB Local, set endpoint option
+file_backend:
+  bucket: 'carraway_bucket'
+  prefix: 'files'
+categories:
+  category_key:
+    title: 'Category Name'
+    dir: '/category/path'
+```
+
+Create DynamoDB table.
+
+```
+carraway setup
+
+# You can use different config file name
+# carrway setup -c your_config.yml
+```
 
-TODO: Write usage instructions here
+Run carrway
+
+```
+carraway start
+```
+
+## Configuration
+
+```yaml
+port: 5000 # Optional. Defailt port is 5000
+gatsby_endpoint: 'http://localhost:8000' # Optional. Default is http://localhost:8000
+backend: # Required
+  table_name: 'carraway_table' # Required.
+  endpoint: http://localhost:6000 # Optional. Set if you use DynamoDB Local
+  region: ap-northeast-1 # Optional.
+file_backend:
+  bucket: 'carraway_bucket' # Required
+  prefix: 'files' # Required.
+categories: # Least one category is required
+  category_key:
+    title: 'Category Name'
+    dir: '/category/path'
+labels:
+  label_key: 'Label title'
+```
 
 ## Development
 
+### Run DynamoDB Local
+```
+docker-compose -f docker/docker-compose.yml up
+```
+
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
 
 To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).

data/carraway.gemspec

@@ -31,4 +31,7 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "rake", "~> 10.0"
   spec.add_development_dependency "rspec", "~> 3.0"
   spec.add_development_dependency "pry"
+  spec.add_development_dependency "rack-test"
+  spec.add_development_dependency "webmock"
+  spec.add_development_dependency "simplecov"
 end

data/docker/docker-compose.yml

@@ -0,0 +1,9 @@
+version: '3'
+services:
+  dynamodb:
+    image: amazon/dynamodb-local
+    ports:
+      - '6000:6000'
+    command: -jar DynamoDBLocal.jar -dbPath /var/lib/dynamodb -port 6000
+    volumes:
+      - /tmp:/var/lib/dynamodb

data/lib/carraway/config.rb

@@ -23,6 +23,10 @@ module Carraway
       def file_backend
         @config['file_backend']
       end
+
+      def labels
+        @config['labels'] || {}
+      end
     end
   end
 end

data/lib/carraway/file.rb

@@ -3,38 +3,7 @@ require 'aws-sdk-s3'
 
 module Carraway
   class File
-    class << self
-      def all
-        query = { table_name: Config.backend['table_name'] }
-        query[:filter_expression] = <<~FILTER
-          record_type = :type
-        FILTER
-        query[:expression_attribute_values] = { ':type' => 'file' }
-
-        dynamo_client.scan(query).items.map do |item|
-          new(
-            uid: item['uid'],
-            title: item['title'],
-            created: item['created']
-          )
-        end
-      end
-
-      def dynamo_client
-        if Config.backend['endpoint']
-          Aws::DynamoDB::Client.new(
-            endpoint: Config.backend['endpoint'],
-            region: Config.backend['region'],
-            access_key_id: 'dummy',
-            secret_access_key: 'dummy'
-          )
-        else
-          Aws::DynamoDB::Client.new
-        end
-      end
-    end
-
-    attr_reader :title, :uid, :created
+    attr_reader :title, :uid, :created, :file
 
     def initialize(title:, file: nil, uid: nil, created: nil)
       @title = title
@@ -50,36 +19,17 @@ module Carraway
       end
     end
 
-    # FIXME duplicate impl on Post
-    def generate_uid
-      [Time.now.strftime('%Y%m%d%H%M%S'), "%05d" % rand(10000)].join
-    end
-
-    def s3_client
-      Aws::S3::Client.new
-    end
-
     def path
       ext = '.pdf' # FIXME Accept other type
+      # Seems prefix does not have to required parameter
       [Config.file_backend['prefix'], '/', @uid, ext].join
     end
 
-    def save(at = Time.now)
-      self.class.dynamo_client.put_item(
-        table_name: Config.backend['table_name'],
-        item: {
-          uid: @uid,
-          record_type: 'file',
-          title: @title,
-          created: at.to_i
-        }
-      )
-      s3_client.put_object(
-        body: @file[:tempfile],
-        bucket: Config.file_backend['bucket'],
-        acl: 'public-read',
-        key: path
-      )
+    private
+
+    # FIXME duplicate impl on Post
+    def generate_uid
+      [Time.now.strftime('%Y%m%d%H%M%S'), "%05d" % rand(10000)].join
     end
   end
 end

data/lib/carraway/file_repository.rb

@@ -0,0 +1,58 @@
+module Carraway
+  class FileRepository
+    def all
+      query = { table_name: Config.backend['table_name'] }
+      query[:filter_expression] = <<~FILTER
+          record_type = :type
+        FILTER
+      query[:expression_attribute_values] = {
+        ':type' => 'file'
+      }
+
+      client.scan(query).items.map do |item|
+        Carraway::File.new(
+          uid: item['uid'],
+          title: item['title'],
+          created: item['created']
+        )
+      end
+    end
+
+    def save(file, at: Time.now)
+      client.put_item(
+        table_name: Config.backend['table_name'],
+        item: {
+          uid: file.uid,
+          record_type: 'file',
+          title: file.title,
+          created: at.to_i
+        }
+      )
+      s3_client.put_object(
+        body: file.file[:tempfile],
+        bucket: Config.file_backend['bucket'],
+        acl: 'public-read',
+        key: file.path
+      )
+    end
+
+    private
+
+    def client
+      if Config.backend['endpoint']
+        Aws::DynamoDB::Client.new(
+          endpoint: Config.backend['endpoint'],
+          region: Config.backend['region'],
+          access_key_id: 'dummy',
+          secret_access_key: 'dummy'
+        )
+      else
+        Aws::DynamoDB::Client.new
+      end
+    end
+
+    def s3_client
+      Aws::S3::Client.new
+    end
+  end
+end

data/lib/carraway/post.rb

@@ -27,7 +27,7 @@ module Carraway
         [Time.now.strftime('%Y%m%d%H%M%S'), "%05d" % rand(10000)].join
       end
 
-      def create(title:, body:, category_key:, at: Time.now)
+      def create(title:, body:, category_key:, at: Time.now, published: nil, labels: nil)
         category = Category.find(category_key)
         # FIXME check path to prevent overwriting
         post = new(
@@ -35,9 +35,10 @@ module Carraway
           title: title,
           body: body,
           category: category,
+          labels: labels,
           created: at.to_i,
           updated: at.to_i,
-          published: nil
+          published: published
         )
         post.save(at: at)
         post
@@ -65,6 +66,7 @@ module Carraway
             uid: item['uid'],
             title: item['title'],
             body: item['body'],
+            labels: item['labels'],
             category: Category.find(item['category']),
             created: Time.at(item['created']),
             updated: Time.at(item['updated']),
@@ -85,6 +87,7 @@ module Carraway
             uid: item['uid'],
             title: item['title'],
             body: item['body'],
+            labels: item['labels'],
             category: Category.find(item['category']),
             created: Time.at(item['created']),
             updated: Time.at(item['updated']),
@@ -108,13 +111,14 @@ module Carraway
     end
 
     attr_reader :uid, :title, :body, :category, :created, :updated
-    attr_accessor :published
+    attr_accessor :published, :labels
 
-    def initialize(uid:, title:, body:, category:, created:, updated:, published:)
+    def initialize(uid:, title:, body:, category:, created:, updated:, published:, labels: nil)
       @uid = uid
       @title = title
       @body = body
       @category = category
+      @labels = labels
       @created = created
       @updated = updated
       @published = published
@@ -127,9 +131,10 @@ module Carraway
       end
     end
 
-    def assign(title:, body:)
+    def assign(title:, body:, labels: nil)
       @title = title
       @body = body
+      @labels = labels
     end
 
     def save(at: Time.now)
@@ -158,6 +163,7 @@ module Carraway
         title: @title,
         body: @body,
         path: path,
+        labels: @labels,
         record_type: 'post',
         category: @category.key,
         created: @created.to_i,

data/lib/carraway/server.rb

@@ -38,13 +38,13 @@ module Carraway
     end
 
     get '/carraway/new' do
-      @files = File.all
+      @files = FileRepository.new.all
       erb :new
     end
 
     get %r{/carraway/edit/(\d+)} do |uid|
       @post = Post.find(uid)
-      @files = File.all
+      @files = FileRepository.new.all
       # FIXME handle not found
       erb :edit
     end
@@ -67,7 +67,8 @@ module Carraway
       @post = Post.create(
         title: params[:title],
         body: params[:body],
-        category_key: params[:category]
+        category_key: params[:category],
+        labels: params[:labels],
       )
       flash[:message] = 'Created'
       redirect "/carraway/edit/#{@post.uid}"
@@ -78,7 +79,8 @@ module Carraway
       # FIXME handle not found
       @post.assign(
         title: params[:title],
-        body: params[:body]
+        body: params[:body],
+        labels: params[:labels],
       )
       # FIXME validation
       @post.save
@@ -121,13 +123,14 @@ module Carraway
     end
 
     get '/carraway/files' do
-      @files = File.all
+      @files = FileRepository.new.all
       erb :files
     end
 
     post '/carraway/files' do
       file = File.new(title: params[:title], file: params[:file])
-      file.save # FIXME validation and error
+      # FIXME validation and error
+      FileRepository.new.save(file)
       flash[:message] = "Saved #{file.path}"
       redirect "/carraway/files"
     end

data/lib/carraway/version.rb

@@ -1,3 +1,3 @@
 module Carraway
-  VERSION = "0.9.0"
+  VERSION = "0.10.0"
 end

data/lib/carraway/views/edit.erb

@@ -19,6 +19,14 @@
           </tr>
         </tbody>
       </table>
+      <% Carraway::Config.labels.each do |key, title| %>
+        <p>
+          <label>
+            <input type="checkbox" class="filled-in" name="labels[]" value="<%= key %>" <%= @post.labels&.include?(key) ? 'checked' : nil %> />
+            <span><%= title %></span>
+          </label>
+        </p>
+      <% end %>
       <div class="input-field col s12">
         <input type="text" id="title" name="title" placeholder="記事タイトル" value="<%= @post.title %>">
         <label for="title">記事タイトル</label>

data/lib/carraway/views/new.erb

@@ -8,6 +8,14 @@
           <option value="<%= category.key %>"><%= category.title %></option>
         <% end %>
       </select>
+      <% Carraway::Config.labels.each do |key, title| %>
+        <p>
+          <label>
+            <input type="checkbox" class="filled-in" name="labels[]" value="<%= key %>" />
+            <span><%= title %></span>
+          </label>
+        </p>
+      <% end %>
       <div class="input-field col s12">
         <input type="text" id="title" name="title" placeholder="記事タイトル">
         <label for="title">記事タイトル</label>

data/lib/carraway.rb

@@ -5,5 +5,6 @@ require 'carraway/version'
 require 'carraway/category'
 require 'carraway/post'
 require 'carraway/file'
+require 'carraway/file_repository'
 require 'carraway/config'
 require 'carraway/server'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: carraway
 version: !ruby/object:Gem::Version
-  version: 0.9.0
+  version: 0.10.0
 platform: ruby
 authors:
 - adorechic
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-11-07 00:00:00.000000000 Z
+date: 2019-02-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thor
@@ -150,6 +150,48 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: rack-test
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: GatsbyJS backend
 email:
 - adorechic@gmail.com
@@ -170,12 +212,14 @@ files:
 - bin/develop
 - bin/setup
 - carraway.gemspec
+- docker/docker-compose.yml
 - exe/carraway
 - lib/carraway.rb
 - lib/carraway/category.rb
 - lib/carraway/cli.rb
 - lib/carraway/config.rb
 - lib/carraway/file.rb
+- lib/carraway/file_repository.rb
 - lib/carraway/post.rb
 - lib/carraway/server.rb
 - lib/carraway/version.rb