contentful-database-importer 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 98d3aacd7022ac369a2b9b81cd21048d52d1da11
-  data.tar.gz: 063b897d2875b9ac709da9f930035f108b41c135
+  metadata.gz: 452224245e7a1c58fdb80466f7beef6911546e4d
+  data.tar.gz: 7f860c92ea18230ecc8a7a50b7a39fc6be06fe32
 SHA512:
-  metadata.gz: 9b3a9767b6a65e6e5fc9ad2efb26e68190411b358f35e9fa25e8075cbfbae1943e6851f759447d76a819dd9f1baa91e610e86af3277c970e274e914c2309f585
-  data.tar.gz: 99db145e30c2adf4bfb8b3e07c49d5626f6576f331aaccd7ed41a142eacbe0a336ecd074671667cea63ffb5cb25ee7407d4908275b9ab26ebad12fc6ebedacca
+  metadata.gz: faa9477146f720378be62b5299ea633e4bec319ac930c181138ff47bf7f9d10e2837736bbd2f0bd4895350cf424ee0c7709a5dfad9613df8ab0db314e5698d62
+  data.tar.gz: 30589e531b05f151f1b6e66a74f527cdcab762579fd72ef6af03818e307fce78c1aae941fdef7874bd43ef7d6eed2d5f2b931fd43cc698e0e7d78b0542beef6a

data/CHANGELOG.md

@@ -0,0 +1,20 @@
+# CHANGELOG
+
+## Unreleased
+
+## 0.2.0
+
+### Added
+* Added `::update_space!` command - [#2](https://github.com/contentful/contentful-database-importer.rb/issues/2)
+* Added `:skip_content_types` configuration option for `::update_space!`
+* Added `::query` support on `Resource` for selecting specific content for a table
+
+## 0.1.0
+
+Initial version which includes all the basic features including:
+
+* Major Databases Support
+* Database to Content Type Mapping
+* Field-level transformations
+* Contentful Bootstrap JSON Generation
+* Space creation

data/Guardfile

@@ -1,14 +1,19 @@
-guard :rspec, cmd: "bundle exec rspec" do
-  require "guard/rspec/dsl"
-  dsl = Guard::RSpec::Dsl.new(self)
+group :green_red_refactor, halt_on_fail: true do
+  guard :rspec, cmd: "bundle exec rspec" do
+    require "guard/rspec/dsl"
+    dsl = Guard::RSpec::Dsl.new(self)
 
-  # RSpec files
-  rspec = dsl.rspec
-  watch(rspec.spec_helper) { rspec.spec_dir }
-  watch(rspec.spec_support) { rspec.spec_dir }
-  watch(rspec.spec_files)
+    # RSpec files
+    rspec = dsl.rspec
+    watch(rspec.spec_helper) { rspec.spec_dir }
+    watch(rspec.spec_support) { rspec.spec_dir }
+    watch(rspec.spec_files)
 
-  # Ruby files
-  ruby = dsl.ruby
-  dsl.watch_spec_files_for(ruby.lib_files)
+    # Ruby files
+    ruby = dsl.ruby
+    dsl.watch_spec_files_for(ruby.lib_files)
+  end
+
+  guard :rubocop, cmd: "rubocop", all_on_start: false, cli: ['--format', 'clang', 'lib'] do
+  end
 end

data/README.md

@@ -211,12 +211,33 @@ In the case of circular references, you will have to create 2 or more classes po
 
 **Note**: Merge classes require at least 1 field declared, even if it's excluded from output.
 
+### Querying
+
+You might want to reduce your datasets to specific subsets, in that case, you can use Querying to specify your subsets of data.
+
+A query is an `SQL String`. E.g: `foo = 'bar' AND baz > 2`.
+
+This is optional and can be specified in the Resource like follows:
+
+```ruby
+class MyResource
+  include Contentful::DatabaseImporter::Resource
+
+  self.query = "foo = 'bar' AND baz > 2"
+
+  field :foo, type: :string
+  field :baz, type: :integer
+end
+```
+
 ### Configuration
 
 ```ruby
 Contentful::DatabaseImporter.setup do |config|
-  config.space_name = 'My Cool New Space' # Required - the destination space name
+  config.space_name = 'My Cool New Space' # Required only for `::run!` - the destination space name
+  config.space_id = 'aAbBcC123foo' # Required only for `::update_space!` - the destination space ID
   config.database_connection = 'postgres://user:pass@host:port' # Required - the DB Connection string
+  config.skip_content_types = true # Optional (only for `::update_space!`) - defaults to `true` - Skips Content Type creation upon updating a space
 end
 ```
 
@@ -248,6 +269,12 @@ Contentful::DatabaseImporter.generate_json!
 Contentful::DatabaseImporter.run!
 ```
 
+* Generate the JSON and Import it to Contentful (updates a Space with all the content):
+
+```ruby
+Contentful::DatabaseImporter.update_space!
+```
+
 ## Contributing
 
 Feel free to improve this tool by submitting a Pull Request. For more information, please read [CONTRIBUTING.md](./CONTRIBUTING.md)

data/contentful-database-importer.gemspec

@@ -32,5 +32,6 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'simplecov'
   spec.add_development_dependency 'guard'
   spec.add_development_dependency 'guard-rspec'
+  spec.add_development_dependency 'guard-rubocop'
   spec.add_development_dependency 'pry'
 end

data/lib/contentful/database_importer/config.rb

@@ -2,11 +2,26 @@ module Contentful
   module DatabaseImporter
     # Configuration for Importer
     class Config
-      attr_accessor :space_name, :database_connection
+      attr_accessor :space_name,
+                    :space_id,
+                    :database_connection,
+                    :skip_content_types
 
-      def complete?
+      def initialize
+        @skip_content_types = true
+      end
+
+      def complete_for_run?
         !space_name.nil? && !database_connection.nil?
       end
+
+      def complete_for_update?
+        !space_id.nil? && !database_connection.nil?
+      end
+
+      def complete?
+        complete_for_run? || complete_for_update?
+      end
     end
   end
 end

data/lib/contentful/database_importer/resource.rb

@@ -1,8 +1,9 @@
 require 'contentful/database_importer/support'
-require 'contentful/database_importer/resource_class_methods'
 require 'contentful/database_importer/resource_coercions'
 require 'contentful/database_importer/resource_relationships'
 require 'contentful/database_importer/resource_bootstrap_methods'
+require 'contentful/database_importer/resource_class_methods'
+require 'contentful/database_importer/resource_field_class_methods'
 require 'contentful/database_importer/resource_bootstrap_class_methods'
 require 'mimemagic'
 
@@ -17,6 +18,7 @@ module Contentful
 
       def self.included(base)
         base.extend(ResourceClassMethods)
+        base.extend(ResourceFieldClassMethods)
         base.extend(ResourceBootstrapClassMethods)
       end
 

data/lib/contentful/database_importer/resource_class_methods.rb

@@ -29,6 +29,14 @@ module Contentful
         @content_type_name = name
       end
 
+      def query
+        @query
+      end
+
+      def query=(query)
+        @query = query
+      end
+
       def default_generator_options
         {
           table_name: table_name,
@@ -54,68 +62,13 @@ module Contentful
         @display_field = field_name
       end
 
-      def fields
-        @fields || []
-      end
-
-      def relationship_fields
-        @fields.select { |f| resource?(f[:type]) }
-      end
-
-      def prepare_standard_field_options(database_name, options)
-        {
-          db_name: database_name,
-          maps_to: options.fetch(:maps_to, database_name),
-          name: options.fetch(:name, database_name),
-          type: options.fetch(:type),
-          pre_process: options.fetch(:pre_process, nil),
-          exclude_from_output: options.fetch(:exclude_from_output, false)
-        }
-      end
-
-      def prepare_field(database_name, options)
-        field = prepare_standard_field_options(database_name, options)
-        field[:item_type] = options.fetch(:item_type) if field[:type] == :array
-        fetch_relationship_options(
-          field,
-          options
-        ) if options.fetch(:relationship, false)
-
-        field
-      end
-
-      def field(database_name, options = {})
-        @fields ||= []
-        @fields << prepare_field(database_name, options)
-      end
-
-      def fetch_many_relationship_options(field, options)
-        field[:id_field] = options.fetch(:id_field)
-        field[:key] = options.fetch(:key)
-      end
-      alias fetch_one_relationship_options fetch_many_relationship_options
-
-      def fetch_through_relationship_options(field, options)
-        field[:through] = options.fetch(:through)
-        field[:primary_id_field] = options.fetch(:primary_id_field)
-        field[:foreign_id_field] = options.fetch(:foreign_id_field)
-        field[:primary_key] = options.fetch(:primary_key)
-        field[:foreign_key] = options.fetch(:foreign_key)
-      end
-
-      def fetch_relationship_options(field, options)
-        field[:relationship] = options.fetch(:relationship)
-
-        send(
-          "fetch_#{options.fetch(:relationship)}_relationship_options",
-          field,
-          options
-        )
+      def table
+        Contentful::DatabaseImporter.database[table_name]
       end
 
       def all
         entries = []
-        rows = Contentful::DatabaseImporter.database[table_name].all
+        rows = table.where(query).all
         rows.each_with_index do |row, index|
           entries << new(row, index)
         end

data/lib/contentful/database_importer/resource_field_class_methods.rb

@@ -0,0 +1,65 @@
+module Contentful
+  module DatabaseImporter
+    # Field related Class Methods for Resource
+    module ResourceFieldClassMethods
+      def field(database_name, options = {})
+        @fields ||= []
+        @fields << prepare_field(database_name, options)
+      end
+
+      def fields
+        @fields || []
+      end
+
+      def relationship_fields
+        @fields.select { |f| resource?(f[:type]) }
+      end
+
+      def prepare_standard_field_options(database_name, options)
+        {
+          db_name: database_name,
+          maps_to: options.fetch(:maps_to, database_name),
+          name: options.fetch(:name, database_name),
+          type: options.fetch(:type),
+          pre_process: options.fetch(:pre_process, nil),
+          exclude_from_output: options.fetch(:exclude_from_output, false)
+        }
+      end
+
+      def prepare_field(database_name, options)
+        field = prepare_standard_field_options(database_name, options)
+        field[:item_type] = options.fetch(:item_type) if field[:type] == :array
+        fetch_relationship_options(
+          field,
+          options
+        ) if options.fetch(:relationship, false)
+
+        field
+      end
+
+      def fetch_many_relationship_options(field, options)
+        field[:id_field] = options.fetch(:id_field)
+        field[:key] = options.fetch(:key)
+      end
+      alias fetch_one_relationship_options fetch_many_relationship_options
+
+      def fetch_through_relationship_options(field, options)
+        field[:through] = options.fetch(:through)
+        field[:primary_id_field] = options.fetch(:primary_id_field)
+        field[:foreign_id_field] = options.fetch(:foreign_id_field)
+        field[:primary_key] = options.fetch(:primary_key)
+        field[:foreign_key] = options.fetch(:foreign_key)
+      end
+
+      def fetch_relationship_options(field, options)
+        field[:relationship] = options.fetch(:relationship)
+
+        send(
+          "fetch_#{options.fetch(:relationship)}_relationship_options",
+          field,
+          options
+        )
+      end
+    end
+  end
+end

data/lib/contentful/database_importer/version.rb

@@ -1,5 +1,5 @@
 module Contentful
   module DatabaseImporter
-    VERSION = '0.1.0'.freeze
+    VERSION = '0.2.0'.freeze
   end
 end

data/lib/contentful/database_importer.rb

@@ -37,10 +37,14 @@ module Contentful
       JsonGenerator.generate_json!
     end
 
-    def self.run_bootstrap!(file, json)
-      file.write(json)
+    def self.generate_json_file!
+      file = Tempfile.new("import_#{config.space_name}")
+      file.write(generate_json!)
       file.close
+      file
+    end
 
+    def self.bootstrap_create_space!(file)
       Contentful::Bootstrap::CommandRunner.new.create_space(
         config.space_name,
         json_template: file.path
@@ -49,11 +53,24 @@ module Contentful
       file.unlink
     end
 
+    def self.bootstrap_update_space!(file)
+      Contentful::Bootstrap::CommandRunner.new.update_space(
+        config.space_id,
+        json_template: file.path,
+        skip_content_types: config.skip_content_types
+      )
+    ensure
+      file.unlink
+    end
+
     def self.run!
-      json = generate_json!
+      raise 'Configuration is incomplete' unless config.complete_for_run?
+      bootstrap_create_space!(generate_json_file!)
+    end
 
-      file = Tempfile.new("import_#{config.space_name}")
-      run_bootstrap!(file, json)
+    def self.update_space!
+      raise 'Configuration is incomplete' unless config.complete_for_update?
+      bootstrap_update_space!(generate_json_file!)
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: contentful-database-importer
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Contentful GmbH (David Litvak Bruno)
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-11-03 00:00:00.000000000 Z
+date: 2016-11-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: contentful_bootstrap
@@ -178,6 +178,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: guard-rubocop
+  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: pry
   requirement: !ruby/object:Gem::Requirement
@@ -202,6 +216,7 @@ files:
 - ".gitignore"
 - ".rspec"
 - ".travis.yml"
+- CHANGELOG.md
 - CODE_OF_CONDUCT.md
 - CONTRIBUTING.md
 - Gemfile
@@ -221,6 +236,7 @@ files:
 - lib/contentful/database_importer/resource_bootstrap_methods.rb
 - lib/contentful/database_importer/resource_class_methods.rb
 - lib/contentful/database_importer/resource_coercions.rb
+- lib/contentful/database_importer/resource_field_class_methods.rb
 - lib/contentful/database_importer/resource_relationships.rb
 - lib/contentful/database_importer/support.rb
 - lib/contentful/database_importer/version.rb