contentful_bootstrap 0.0.7 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3722c92f03d28db69baa4bfc4811c9f470ed3933
-  data.tar.gz: bc92ff0935223a804eee9a4772dbda0204988555
+  metadata.gz: a1889695468ff7c1a8250d9fa14e88d81167df6a
+  data.tar.gz: 5e6634f55c894b036d5580d8b31d9d5e8f207d13
 SHA512:
-  metadata.gz: c8fcceb2946f37f5a613ae785959e7ed01105f1306e087e20b3dcc0a6a7822a29153f3c4c2117166e15667364ca7ab333ca14f10496a1c13e56a90ff0dbb2bf1
-  data.tar.gz: c51f6badb7f23fcaa0ce7fb580d599d6acbec1ebf4df4e26345eb16ad8f43cc5f35d53f36b41c4f8582e8158d8622468eb6add0a0e6eff2f830fbddb58f7b16a
+  metadata.gz: 81a56b64246f4b7bea76a0161d7d8c361090f643a8d0b2e8f0fa63c5dec0cc394560b940d0ba1d6b5d1e76f817bdf880fa61d63a99f6d121f21df50c04803ebb
+  data.tar.gz: 00d5ab1fb4dc4a68e4a97f421875c7b6d3422c0a2d5fe8255844b4e3cb70b3115ecc8640b18544c7329eb67f001edace299bcc87d96ccd940706a5dd3d0f0f98

data/CHANGELOG.md

@@ -1,6 +1,27 @@
 # Change Log
 ## Unreleased
 
+## v1.1.0
+### Removed
+* Removed `init` command as `v1.0.0` refactor removed it's necessity
+
+## v1.0.1 [YANKED]
+### Fixed
+* Release is now on `master`
+
+## v1.0.0 [YANKED]
+### Changed
+* Changed namespace from `ContentfulBootstrap` to `Contentful::Bootstrap` to mimic other libraries
+* Changed repository name from `contentful_bootstrap.rb` to `contentful-bootstrap.rb` to mimic other libraries
+* Delivery API Token will always get created when using `contentful_bootstrap` commands to create a space
+* Configuration now read from `~/.contentfulrc`
+* Tool now requests user to allow to write configuration files
+
+### Added
+* `contentful-bootstrap.rb` version number to API Token description
+* `inifile` as runtime dependency
+* Add optional `--config CONFIG_PATH` parameter to commands
+
 ## v0.0.7
 ### Fixed
 * Redirected Favicon fetch to Contentful's favicon, as some browsers would ping the server indefinitely

data/Gemfile

@@ -2,4 +2,5 @@
 source "https://rubygems.org"
 
 gem "launchy"
+gem "inifile"
 gem "contentful-management"

data/README.md

@@ -4,7 +4,7 @@ A small CLI tool for getting started with Contentful
 
 ## Contentful
 [Contentful](http://www.contentful.com) is a content management platform for web applications,
-mobile apps and connected devices. It allows you to create, edit  manage content in the cloud
+mobile apps and connected devices. It allows you to create, edit & manage content in the cloud
 and publish it anywhere via powerful API. Contentful offers tools for managing editorial
 teams and enabling cooperation between organizations.
 
@@ -20,24 +20,19 @@ in a single command
 $ gem install contentful_bootstrap
 ```
 
-### First Usage
-
-```bash
-$ contentful_bootstrap init <space_name> [--template template_name]
-```
+### Usage
 
-
-Then you can create other spaces by doing:
+You can create spaces by doing
 
 ```bash
-$ contentful_bootstrap create_space <space_name> [--template template_name]
+$ contentful_bootstrap create_space <space_name> [--template template_name] [--config CONFIG_PATH]
 ```
 
 
 You can also generate new Delivery API Tokens by doing:
 
 ```bash
-$ contentful_bootstrap generate_token <space_id> [--name token_name]
+$ contentful_bootstrap generate_token <space_id> [--name token_name] [--config CONFIG_PATH]
 ```
 
 ### Available templates
@@ -64,24 +59,38 @@ gem "contentful_bootstrap"
 Require `contentful_bootstrap`
 
 ```ruby
-require 'contentful_bootstrap'
+require 'contentful/bootstrap'
 ```
 
-To do the complete `init` process
+To Create a new Space
 
 ```ruby
-ContentfulBootstrap::Commands.new.init("space_name", "template_name") # Template Name is optional
+Contentful::Bootstrap::Commands.new.create_space("space_name", "template_name") # Template Name is optional
 ```
 
-
-To create a new Space or Token. *This operations require a CMA Token located in `File.join(Dir.pwd, '.contentful_token')`*
+To Create a new Delivery API Token
 
 ```ruby
-# Create a new Space
-ContentfulBootstrap::Commands.new.create_space("space_name", "template_name") # Template Name is optional
+Contentful::Bootstrap::Commands.new.generate_token("space_id", "token_name") # Token Name is optional
+```
+
+Optionally, `Commands#new` will take a parameter for specifying a configuration path
+
+### Configuration
+
+Contentful Bootstrap will read by default from `~/.contentfulrc`, but you can provide your own
+file by using the `--config CONFIG_PATH` parameter
+
+If you don't have `~/.contentfulrc` created, you will be prompted if you want to create it
+
+#### Configuration Format
+
+The configuration file will be in `ini` format and looks like the following
 
-# Create a new CDA Access Token
-ContentfulBootstrap::Commands.new.generate_token("space_id", "token_name") # Token Name is optional
+```ini
+[global]
+CONTENTFUL_MANAGEMENT_ACCESS_TOKEN = a_management_access_token
+CONTENTFUL_DELIVERY_ACCESS_TOKEN = a_delivery_acces_token      ; Delivery Access Token is not required for this tool, but can be generated by it
 ```
 
 ## Contributing

data/bin/contentful_bootstrap

@@ -1,37 +1,37 @@
 #!/usr/bin/env ruby
 
 require 'optparse'
-require 'contentful_bootstrap/commands'
+require 'contentful/bootstrap/commands'
 
 options = {}
 global = OptionParser.new do |opts|
-  opts.banner = "Usage: contentful_bootstrap <command> <space_name> [--template TEMPLATE_NAME]"
+  opts.banner = "Usage: contentful_bootstrap <command> <space_name> [--template TEMPLATE_NAME] [--config CONFIG_PATH]"
   opts.separator ""
   opts.separator <<-HELP
     Available commands are:
-      init
       create_space
+      generate_token
   HELP
 end
 
 subcommands = {
-  'init' => OptionParser.new do |opts|
-    opts.banner = "Usage: init <space_name> [--template TEMPLATE_NAME]"
-    opts.on("-t TEMPLATE", "--template TEMPLATE", "Specify Template", "blog, catalogue, gallery") do |t|
-      options[:name] = t
-    end
-  end,
   'create_space' => OptionParser.new do |opts|
     opts.banner = "Usage: init <space_name> [--template TEMPLATE_NAME]"
     opts.on("-t TEMPLATE", "--template TEMPLATE", "Specify Template", "blog, catalogue, gallery") do |t|
       options[:name] = t
     end
+    opts.on("-c CONFIG_PATH", "--config CONFIG_PATH", "Specify Configuration Path") do |c|
+      options[:config_path] = c
+    end
   end,
   'generate_token' => OptionParser.new do |opts|
     opts.banner = "Usage: generate_token <space_id> [--name TOKEN_NAME]"
     opts.on("-n NAME", "--name TEMPLATE", "Specify Token Name") do |n|
       options[:name] = n
     end
+    opts.on("-c CONFIG_PATH", "--config CONFIG_PATH", "Specify Configuration Path") do |c|
+      options[:config_path] = c
+    end
   end
 }
 
@@ -49,14 +49,13 @@ if subcommands.has_key? command
     exit
   end
 
-  ContentfulBootstrap::Commands.new.send(command, space, options.fetch(:name, nil))
+  Contentful::Bootstrap::Commands.new(options.fetch(:config_path, "")).send(command, space, options.fetch(:name, nil))
 else
   puts "Usage: contentful_bootstrap <command> <space> [options]"
   puts
   puts <<-HELP
     Subcommand not available or missing
     Available commands are:
-      init
       create_space
       generate_token
   HELP

data/contentful_bootstrap.gemspec

@@ -1,11 +1,11 @@
 # coding: utf-8
 lib = File.expand_path('../lib', __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require 'contentful_bootstrap/version'
+require 'contentful/bootstrap/version'
 
 Gem::Specification.new do |spec|
   spec.name          = "contentful_bootstrap"
-  spec.version       = ContentfulBootstrap::VERSION
+  spec.version       = Contentful::Bootstrap::VERSION
   spec.authors       = ["David Litvak Bruno"]
   spec.email         = ["david.litvakb@gmail.com"]
   spec.summary       = %q{Contentful CLI tool for getting started with Contentful}
@@ -21,4 +21,5 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "rake"
   spec.add_runtime_dependency "launchy"
   spec.add_runtime_dependency "contentful-management"
+  spec.add_runtime_dependency "inifile"
 end

data/lib/contentful/bootstrap.rb

@@ -0,0 +1,5 @@
+require "contentful/bootstrap/version"
+require "contentful/bootstrap/server"
+require "contentful/bootstrap/commands"
+require "contentful/bootstrap/templates"
+require "contentful/bootstrap/token"

data/lib/contentful/bootstrap/commands.rb

@@ -0,0 +1,135 @@
+require "net/http"
+require "contentful/management"
+require "contentful/management/request"
+require "contentful/management/error"
+require "contentful/bootstrap/token"
+require "contentful/bootstrap/server"
+require "contentful/bootstrap/support"
+require "contentful/bootstrap/templates"
+require "contentful/bootstrap/version"
+
+module Contentful
+  module Bootstrap
+    class Commands
+      include Support
+
+      def initialize(config_path = "")
+        Token.set_path!(config_path)
+      end
+
+      def create_space(space_name, template_name = nil, from_command = true)
+        get_configuration if from_command
+
+        management_client_init
+
+        puts "Creating Space '#{space_name}'"
+        space = nil
+        begin
+          space = Contentful::Management::Space.create(name: space_name)
+        rescue Contentful::Management::NotFound
+          puts "Your account has multiple organizations"
+          print "Please insert the Organization ID you'd want to create the spaces for: "
+          organization_id = gets.chomp
+          space = Contentful::Management::Space.create(name: space_name, organization_id: organization_id)
+        end
+
+        puts "Space '#{space_name}' created!"
+        puts
+
+        unless template_name.nil?
+          if templates.has_key? template_name.to_sym
+            puts "Creating Template '#{template_name}'"
+
+            templates[template_name.to_sym].new(space).run
+            puts "Template '#{template_name}' created!"
+          else
+            puts "Template '#{template_name}' not found. Valid templates are '#{templates.keys.map(&:to_s).join('\', \'')}'"
+          end
+        end
+
+        token = generate_token(space, "Bootstrap Token", false)
+        puts
+        puts "Space ID: '#{space.id}'"
+        puts "Access Token: '#{token}'"
+        puts
+        puts "You can now insert those values into your configuration blocks"
+      end
+
+      def generate_token(space, token_name = "Bootstrap Token", from_command = true)
+        get_configuration if from_command
+        management_client_init if from_command
+
+        if space.is_a?(String)
+          space = Contentful::Management::Space.find(space)
+        end
+
+        puts
+        puts "Creating Delivery API Token"
+
+        response = Contentful::Management::Request.new(
+          "/#{space.id}/api_keys",
+          'name' => token_name,
+          'description' => "Created with 'contentful_bootstrap.rb v#{Contentful::Bootstrap::VERSION}'"
+        ).post
+        fail response if response.object.is_a?(Contentful::Management::Error)
+        token = response.object["accessToken"]
+
+        puts "Token '#{token_name}' created! - '#{token}'"
+        print "Do you want to write the Delivery Token to your configuration file? (Y/n): "
+        Token.write_access_token(token) unless gets.chomp.downcase == "n"
+
+        token
+      end
+
+      private
+      def get_configuration
+        if !Token.present?
+          print "OAuth Token not found, do you want to create a new configuration file? (Y/n): "
+          if gets.chomp.downcase == "n"
+            puts "Exiting!"
+            return
+          end
+          puts "Configuration will be saved on #{Token.filename}"
+
+          puts "A new tab on your browser will open for requesting OAuth permissions"
+          get_token
+        else
+          puts "OAuth token found, moving on!"
+        end
+        puts
+      end
+
+      def management_client_init
+        Contentful::Management::Client.new(Token.read, raise_errors: true)
+      end
+
+      def get_token
+        silence_stderr do # Don't show any WEBrick related stuff
+          server = Server.new
+
+          server.start
+
+          while !server.running? # Wait for Server Init
+            sleep(1)
+          end
+
+          Net::HTTP.get(URI('http://localhost:5123'))
+
+          while !Token.present? # Wait for User to do OAuth cycle
+            sleep(1)
+          end
+
+          server.stop
+        end
+      end
+
+      def templates
+        {
+          blog: Templates::Blog,
+          gallery: Templates::Gallery,
+          catalogue: Templates::Catalogue
+        }
+      end
+    end
+  end
+end

data/lib/contentful/bootstrap/constants.rb

@@ -0,0 +1,8 @@
+module Contentful
+  module Bootstrap
+    module Constants
+      OAUTH_APP_ID = "a19770bea126e6d596d8599ff42e14173409e3e252895b78d0cb289c10586276".freeze
+      OAUTH_CALLBACK_URL = "http://localhost:5123/oauth_callback".freeze
+    end
+  end
+end

data/lib/contentful/bootstrap/server.rb

@@ -0,0 +1,97 @@
+require "thread"
+require "webrick"
+require "launchy"
+require "contentful/bootstrap/constants"
+require "contentful/bootstrap/token"
+
+module Contentful
+  module Bootstrap
+    class OAuthEchoView
+      def render
+        <<-JS
+        <html><head>
+          <link rel="shortcut icon" type="image/png" href="https://www.contentful.com/assets/images/favicons/favicon-47dc5f9d.png"/>
+          <link rel="shortcut icon" type="image/png" href="https://www.contentful.com/assets/images/favicons/favicon-47dc5f9d.png"/>
+        </head><body>
+        <script type="text/javascript">
+          (function() {
+            var access_token = window.location.hash.split('&')[0].split('=')[1];
+            window.location.replace('http://localhost:5123/save_token?token=' + access_token);
+          })();
+        </script>
+        </body></html>
+        JS
+      end
+    end
+
+    class ThanksView
+      def render
+        <<-HTML
+        <html><head>
+          <link rel="shortcut icon" type="image/png" href="https://www.contentful.com/assets/images/favicons/favicon-47dc5f9d.png"/>
+          <link rel="shortcut icon" type="image/png" href="https://www.contentful.com/assets/images/favicons/favicon-47dc5f9d.png"/>
+          <link rel="stylesheet" href="https://maxcdn.bootstrapcdn.com/bootstrap/3.3.5/css/bootstrap.min.css" />
+        </head><body>
+          <div class="container">
+            <div class="jumbotron">
+              <h1>Contentful Bootstrap</h1>
+              <h4>Thanks! The OAuth Token has been generated</h4>
+              <p>The Space you specified will now start to create. You can close this window freely</p>
+            </div>
+          </div>
+        </body></html>
+        HTML
+      end
+    end
+
+    class IndexController < WEBrick::HTTPServlet::AbstractServlet
+      def do_GET(request, response)
+        client_id = Contentful::Bootstrap::Constants::OAUTH_APP_ID
+        redirect_uri = Contentful::Bootstrap::Constants::OAUTH_CALLBACK_URL
+        scope = "content_management_manage"
+        Launchy.open("https://be.contentful.com/oauth/authorize?response_type=token&client_id=#{client_id}&redirect_uri=#{redirect_uri}&scope=#{scope}")
+        response.status = 200
+        response.body = ""
+      end
+    end
+
+    class OAuthCallbackController < WEBrick::HTTPServlet::AbstractServlet
+      def do_GET(request, response)
+        response.status = 200
+        response.content_type = "text/html"
+        response.body = OAuthEchoView.new.render
+      end
+    end
+
+    class SaveTokenController < WEBrick::HTTPServlet::AbstractServlet
+      def do_GET(request, response)
+        Token.write(request.query["token"])
+        response.status = 200
+        response.content_type = "text/html"
+        response.body = ThanksView.new.render
+      end
+    end
+
+    class Server
+      attr_reader :server
+      def initialize
+        @server = WEBrick::HTTPServer.new(:Port => 5123)
+        @server.mount "/", IndexController
+        @server.mount "/oauth_callback", OAuthCallbackController
+        @server.mount "/save_token", SaveTokenController
+      end
+
+      def start
+        Thread.new { @server.start }
+      end
+
+      def stop
+        @server.shutdown
+      end
+
+      def running?
+        @server.status != :Stop
+      end
+    end
+  end
+end