contentful_bootstrap 1.6.0 → 2.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 350dcf7465b5d8ccd0efcdbb8351e6504bf653c0
-  data.tar.gz: 1c554d4d7ec3606eb026d671660dae89aad58b28
+  metadata.gz: c454afb5aa1257e813b5f668b67c49538091812f
+  data.tar.gz: dc137c43d045a69be4dd75102b7b6389a41be490
 SHA512:
-  metadata.gz: 623d664fcd58c48df3b1067c18ae757d5e831c827f24acc4f01c59a5b7926af1f5681b4b85f9d764c66700043862af4d940620a4c52520f398c189a0e39d3358
-  data.tar.gz: 4fba258364e79b46261f7ef7e5584c6b64090678c5725e9ad0720b5d671cb96704abbfed658d2db94c27ea3a223708248893eb0357c9f960cf89cd0690247fd8
+  metadata.gz: 9890d7da94353a39bf694cba99921f660513490a362d23bd0134ba68eb39253b9ae761f3d96ccf496df1b920717217186b57972923af244be2831578b127f7c4
+  data.tar.gz: 48b153d5610352f98ab2291b63cc87fe6a52cc283163be42babfea205376418d362e6bd5116683dcdf09a646bebd9cd1c641738305c18abf777dc1112e2cf788

data/.rubocop.yml

@@ -0,0 +1,26 @@
+Metrics/LineLength:
+  Max: 120
+  Exclude:
+    - 'lib/contentful/bootstrap/templates/blog.rb'
+    - 'lib/contentful/bootstrap/templates/catalogue.rb'
+    - 'lib/contentful/bootstrap/templates/gallery.rb'
+
+Style/Documentation:
+  Exclude:
+    - 'spec/**/*'
+    - 'test/**/*'
+    - 'lib/contentful/bootstrap/commands.rb'
+    - 'lib/contentful/bootstrap/constants.rb'
+    - 'lib/contentful/bootstrap/generator.rb'
+    - 'lib/contentful/bootstrap/server.rb'
+    - 'lib/contentful/bootstrap/support.rb'
+    - 'lib/contentful/bootstrap/templates/base.rb'
+    - 'lib/contentful/bootstrap/templates/blog.rb'
+    - 'lib/contentful/bootstrap/templates/catalogue.rb'
+    - 'lib/contentful/bootstrap/templates/gallery.rb'
+    - 'lib/contentful/bootstrap/templates/json_template.rb'
+    - 'lib/contentful/bootstrap/templates/links/asset.rb'
+    - 'lib/contentful/bootstrap/templates/links/base.rb'
+    - 'lib/contentful/bootstrap/templates/links/entry.rb'
+    - 'lib/contentful/bootstrap/token.rb'
+    - 'lib/contentful/bootstrap/version.rb'

data/.rubocop_todo.yml

@@ -0,0 +1,123 @@
+# This configuration was generated by
+# `rubocop --auto-gen-config`
+# on 2015-11-12 15:38:57 -0300 using RuboCop version 0.35.1.
+# The point is for the user to remove these configuration records
+# one by one as the offenses are removed from the code base.
+# Note that changes in the inspected code, or installation of new
+# versions of RuboCop, may require this file to be generated again.
+
+# Offense count: 8
+Metrics/AbcSize:
+  Max: 52
+
+# Offense count: 4
+# Configuration parameters: CountComments.
+Metrics/ClassLength:
+  Max: 176
+
+# Offense count: 1
+Metrics/CyclomaticComplexity:
+  Max: 7
+
+# Offense count: 16
+# Configuration parameters: AllowURI, URISchemes.
+Metrics/LineLength:
+  Max: 316
+
+# Offense count: 19
+# Configuration parameters: CountComments.
+Metrics/MethodLength:
+  Max: 88
+
+# Offense count: 1
+Metrics/PerceivedComplexity:
+  Max: 9
+
+# Offense count: 2
+# Cop supports --auto-correct.
+# Configuration parameters: EnforcedStyle, SupportedStyles, ProceduralMethods, FunctionalMethods, IgnoredMethods.
+Style/BlockDelimiters:
+  Exclude:
+    - 'spec/contentful/bootstrap/generator_spec.rb'
+
+# Offense count: 2
+Style/ClassVars:
+  Exclude:
+    - 'lib/contentful/bootstrap/token.rb'
+
+# Offense count: 1
+# Cop supports --auto-correct.
+Style/DeprecatedHashMethods:
+  Exclude:
+    - 'bin/contentful_bootstrap'
+
+# Offense count: 20
+# Configuration parameters: Exclude.
+Style/Documentation:
+  Exclude:
+    - 'spec/**/*'
+    - 'test/**/*'
+    - 'lib/contentful/bootstrap/commands.rb'
+    - 'lib/contentful/bootstrap/constants.rb'
+    - 'lib/contentful/bootstrap/generator.rb'
+    - 'lib/contentful/bootstrap/server.rb'
+    - 'lib/contentful/bootstrap/support.rb'
+    - 'lib/contentful/bootstrap/templates/base.rb'
+    - 'lib/contentful/bootstrap/templates/blog.rb'
+    - 'lib/contentful/bootstrap/templates/catalogue.rb'
+    - 'lib/contentful/bootstrap/templates/gallery.rb'
+    - 'lib/contentful/bootstrap/templates/json_template.rb'
+    - 'lib/contentful/bootstrap/templates/links/asset.rb'
+    - 'lib/contentful/bootstrap/templates/links/base.rb'
+    - 'lib/contentful/bootstrap/templates/links/entry.rb'
+    - 'lib/contentful/bootstrap/token.rb'
+    - 'lib/contentful/bootstrap/version.rb'
+
+# Offense count: 1
+# Configuration parameters: EnforcedStyle, SupportedStyles.
+Style/FormatString:
+  Exclude:
+    - 'lib/contentful/bootstrap/commands.rb'
+
+# Offense count: 1
+# Cop supports --auto-correct.
+# Configuration parameters: MaxLineLength.
+Style/IfUnlessModifier:
+  Exclude:
+    - 'bin/contentful_bootstrap'
+
+# Offense count: 3
+# Configuration parameters: EnforcedStyle, SupportedStyles.
+Style/MethodName:
+  Enabled: false
+
+# Offense count: 2
+Style/MultilineBlockChain:
+  Exclude:
+    - 'lib/contentful/bootstrap/generator.rb'
+
+# Offense count: 1
+# Cop supports --auto-correct.
+# Configuration parameters: PreferredDelimiters.
+Style/PercentLiteralDelimiters:
+  Exclude:
+    - 'contentful_bootstrap.gemspec'
+
+# Offense count: 68
+# Cop supports --auto-correct.
+# Configuration parameters: EnforcedStyle, SupportedStyles.
+Style/StringLiterals:
+  Enabled: false
+
+# Offense count: 1
+# Cop supports --auto-correct.
+# Configuration parameters: EnforcedStyleForMultiline, SupportedStyles.
+Style/TrailingComma:
+  Exclude:
+    - 'bin/contentful_bootstrap'
+
+# Offense count: 1
+# Cop supports --auto-correct.
+Style/UnneededPercentQ:
+  Exclude:
+    - 'contentful_bootstrap.gemspec'

data/.travis.yml

@@ -0,0 +1,6 @@
+language: ruby
+rvm:
+  - 1.9.3
+  - 2.1.7
+  - 2.2.3
+  - 2.0.0

data/CHANGELOG.md

@@ -1,6 +1,31 @@
 # Change Log
+
 ## Unreleased
 
+## v2.0.2
+### Fixed
+* Array and Link handling
+
+### Changed
+* Command now provide better help on incomplete command
+
+## v2.0.1 [YANKED]
+### Changed
+* Scoped File Usage on GenerateJson Command
+
+## v2.0.0 [YANKED]
+### Changed
+* Refactored `Commands` into new classes
+* Renamed `Commands` to `CommandRunner`, kept external interface, moved internal logic to new `Commands` classes
+* Refactored `Token` to be an Object instead of a collection of static behavior
+* General code refactoring and cleanup
+
+### Added
+* More robust mechanism for waiting on processed assets
+* JSON Template generator `generate_json` command
+* Added Specs for almost all the code
+* Applied Rubocop Style guide
+
 ## v1.6.0
 ### Added
 * Support for Symbols in Array fields

data/Gemfile

@@ -6,3 +6,4 @@ gemspec
 gem "launchy"
 gem "inifile"
 gem "contentful-management"
+gem "contentful", "~> 0.7"

data/Guardfile

@@ -0,0 +1,5 @@
+guard :rspec, cmd: 'rspec --format documentation --color' do
+  watch(%r{^spec/.+_spec\.rb$})
+  watch(%r{^lib/(.+)\.rb$})     { |m| "spec/lib/#{m[1]}_spec.rb" }
+  watch('spec/spec_helper.rb')  { "spec" }
+end

data/README.md

@@ -1,3 +1,5 @@
+[![Build Status](https://travis-ci.org/contentful-labs/contentful-bootstrap.rb.svg)](https://travis-ci.org/contentful-labs/contentful-bootstrap.rb)
+
 # Contentful Bootstrap
 
 A small CLI tool for getting started with Contentful
@@ -9,8 +11,7 @@ and publish it anywhere via powerful API. Contentful offers tools for managing e
 teams and enabling cooperation between organizations.
 
 ## What does `contentful_bootstrap` do?
-The aim of `contentful_bootstrap` is to have developers setting up their Contentful environment
-in a single command
+`contentful_bootstrap` let's you set up a new Contentful environment with a single command.
 
 ## How to Use
 
@@ -22,22 +23,27 @@ $ gem install contentful_bootstrap
 
 ### Usage
 
-You can create spaces by doing
+You can create spaces by doing:
 
 ```bash
 $ contentful_bootstrap create_space <space_name> [--template template_name] [--json-template template_path] [--config CONFIG_PATH]
 ```
 
-
 You can also generate new Delivery API Tokens by doing:
 
 ```bash
 $ contentful_bootstrap generate_token <space_id> [--name token_name] [--config CONFIG_PATH]
 ```
 
-### Available templates
+You can also generate JSON Templates from existing spaces by doing:
+
+```bash
+$ contentful_bootstrap generate_json <space_id> <access_token> [--output-file OUTPUT PATH]
+```
 
-The available templates for your spaces are:
+### Built-in templates
+
+Just getting started with Contentful? We have included the following built-in templates:
 
 ```
 blog
@@ -45,8 +51,9 @@ gallery
 catalogue
 ```
 
-This will get you started with Contentful by setting up a Space with some Demo Data to get you
-started as soon as possible with development using our API.
+You can use these with the `--template` option to create some demo data and start developing
+against our APIs right away. Once you've gotten comfortable, you can
+[create your own templates](#json-templates) for quickly replicating testing & development spaces.
 
 ### Using from within other applications
 
@@ -65,7 +72,7 @@ require 'contentful/bootstrap'
 To Create a new Space
 
 ```ruby
-Contentful::Bootstrap::Commands.new.create_space("space_name")
+Contentful::Bootstrap::CommandRunner.new.create_space("space_name")
 ```
 
 Additionally, you can send an options hash with the following keys:
@@ -76,13 +83,13 @@ options = {
   json_template: "/path/to/template.json", # Will use the JSON file specified as a Template
   trigger_oauth: true # if true will trigger OAuth process
 }
-Contentful::Bootstrap::Commands.new.create_space("space_name", options)
+Contentful::Bootstrap::CommandRunner.new.create_space("space_name", options)
 ```
 
 To Create a new Delivery API Token
 
 ```ruby
-Contentful::Bootstrap::Commands.new.generate_token("space_id")
+Contentful::Bootstrap::CommandRunner.new.generate_token("space_id")
 ```
 
 Additionally, you can send an options hash with the following keys:
@@ -92,10 +99,27 @@ options = {
   name: "Some Nice Token Name", # Will Create the Delivery API Token with the specified name
   trigger_oauth: true # if true will trigger OAuth process
 }
-Contentful::Bootstrap::Commands.new.create_space("space_name", options)
+Contentful::Bootstrap::CommandRunner.new.generate_token("space_id", options)
+```
+
+To Generate a JSON Template from an exising Space
+
+```ruby
+Contentful::Bootstrap::CommandRunner.new.generate_json("space_id", access_token: "access_token")
+```
+
+Additionally, you can send an options hash with the following keys:
+**NOTE**: The `:access_token` key is required in the options hash
+
+```ruby
+options = {
+  access_token: "access_token" # REQUIRED
+  filename: "template.json" # Will save the JSON to the specified file
+}
+Contentful::Bootstrap::CommandRunner.new.generate_json("space_id", options)
 ```
 
-Optionally, `Commands#new` will take a parameter for specifying a configuration path
+Optionally, `CommandRunner#new` will take a parameter for specifying a configuration path
 
 ### Configuration
 
@@ -119,7 +143,9 @@ CONTENTFUL_DELIVERY_ACCESS_TOKEN = a_delivery_acces_token      ; Delivery Access
 
 ### JSON Templates
 
-You can find a complete example [here](./examples/templates/catalogue.json)
+Using the `--json-template` option, you can create spaces with your own predefined content.
+This can be useful for creating testing & development spaces or just starting new projects from
+a common baseline. You can find a complete example [here](./examples/templates/catalogue.json)
 
 ## Contributing
 

data/Rakefile

@@ -1,2 +1,9 @@
 require "bundler/gem_tasks"
 
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new do |t|
+  t.rspec_opts = '--format documentation --color'
+end
+
+task test: :spec
+task default: :spec

data/bin/contentful_bootstrap

@@ -1,22 +1,13 @@
 #!/usr/bin/env ruby
 
 require 'optparse'
-require 'contentful/bootstrap/commands'
+require 'contentful/bootstrap/command_runner'
 
 options = {}
-global = OptionParser.new do |opts|
-  opts.banner = "Usage: contentful_bootstrap <command> <space_name> [options]"
-  opts.separator ""
-  opts.separator <<-HELP
-    Available commands are:
-      create_space
-      generate_token
-  HELP
-end
 
 subcommands = {
   'create_space' => OptionParser.new do |opts|
-    opts.banner = "Usage: init <space_name> [--template TEMPLATE_NAME] [--json-template JSON_PATH] [--config CONFIG_PATH]"
+    opts.banner = "Usage: create_space <space_name> [--template TEMPLATE_NAME] [--json-template JSON_PATH] [--config CONFIG_PATH]"
     opts.on("-t TEMPLATE", "--template TEMPLATE", "Specify Template", "Available Templates: blog, catalogue, gallery") do |t|
       options[:template] = t
     end
@@ -41,45 +32,65 @@ subcommands = {
     opts.on_tail("-h", "--help", "Print this message") do
       puts opts
     end
-  end
+  end,
+  'generate_json' => OptionParser.new do |opts|
+    opts.banner = "Usage: generate_json <space_id> <access_token> [--output-file OUTPUT_PATH]"
+    opts.on("-o OUTPUT_PATH", "--output-file OUTPUT_PATH", "Specify Output File") do |f|
+      options[:filename] = f
+    end
+    opts.on_tail("-h", "--help", "Print this message") do
+      puts opts
+    end
+  end,
 }
 
+global = OptionParser.new do |opts|
+  opts.banner = "Usage: contentful_bootstrap <command> <space_name> [options]"
+  opts.separator ""
+  opts.separator <<-HELP
+    Available commands are:
+    \t#{subcommands.keys.sort.join("\n\t")}
+  HELP
+end
+
 global.order!
 command = ARGV.shift
 
 is_help = ARGV.include?("-h") || ARGV.include?("--help")
 space = ARGV.shift unless is_help
 
-unless STDIN.tty? && STDOUT.tty?
-  $stderr.write "This tool requires user interaction\n"
-  $stderr.write "Exiting!\n"
-  exit
-end
+options[:access_token] = ARGV.shift if command == "generate_json" && !is_help
 
 if subcommands.has_key? command
   subcommands[command].order!
 
+  unless STDIN.tty? && STDOUT.tty?
+    $stderr.write "This tool requires user interaction\n"
+    $stderr.write "Exiting!\n"
+    exit
+  end
+
   if is_help
     exit
   end
 
   if space.nil? || space.empty?
-    puts "Usage: contentful_bootstrap <command> <space> [options]"
+    ARGV << '-h'
+    subcommands[command].order!
     puts
-    puts "You must provide a valid space name. Exiting!"
+    puts "Required Arguments not specified. Exiting!"
     exit
   end
 
   options[:trigger_oauth] = true
 
-  Contentful::Bootstrap::Commands.new(options.fetch(:config_path, "")).send(command, space, options)
+  Contentful::Bootstrap::CommandRunner.new(options.fetch(:config_path, "")).send(command, space, options)
 else
   puts "Usage: contentful_bootstrap <command> <space> [options]"
   puts
   puts <<-HELP
     Subcommand not available or missing
     Available commands are:
-      create_space
-      generate_token
   HELP
+  puts "\t#{subcommands.keys.sort.join("\n\t")}"
 end