storageroom-to-contentful 0.0.1

data/.gitignore

@@ -0,0 +1,41 @@
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/test/tmp/
+/test/version_tmp/
+/tmp/
+
+## Specific to RubyMotion:
+.dat*
+.repl_history
+build/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalisation:
+/.bundle/
+/lib/bundler/man/
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+# Gemfile.lock
+# .ruby-version
+# .ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc
+
+#RubyMine
+.idea
+
+
+
+data

data/.rubocop.yml

@@ -0,0 +1,40 @@
+Encoding:
+  Enabled: false
+
+Documentation:
+  Enabled: false
+
+ClassLength:
+  Enabled: false
+
+AllCops:
+  Exclude:
+    - contentful-management.gemspec
+    - bin/cma-console
+
+LineLength:
+  Max: 135
+Style/MethodLength:
+  Max: 15
+
+Style/SpaceInsideBrackets:
+  Enabled: false
+
+Style/CyclomaticComplexity:
+  Max: 8
+
+Style/SpaceInsideHashLiteralBraces:
+  EnforcedStyle: no_space
+  EnforcedStyleForEmptyBraces: no_space
+
+Style/CaseIndentation:
+  Enabled: false
+
+Lint/UselessAssignment:
+  Enabled: false
+
+Style/IndentationWidth:
+  Enabled: false
+
+Style/GuardClause:
+  Enabled: false

data/.travis.yml

@@ -0,0 +1,6 @@
+language: ruby
+rvm:
+- 2.0.0
+- 1.9.3
+- jruby-19mode
+- rbx-2

data/Gemfile

@@ -0,0 +1,11 @@
+source 'https://rubygems.org'
+# Specify your gem's dependencies in storageroom-to-contentful.gemspec
+gemspec
+
+group :test do
+  gem 'rspec'
+  gem 'vcr'
+  gem 'webmock'
+  gem 'simplecov', require: false
+  gem 'rubocop'
+end

data/Gemfile.lock

@@ -0,0 +1,77 @@
+PATH
+  remote: .
+  specs:
+    storageroom-to-contentful (0.0.1)
+      contentful-management (~> 0.2)
+      http (~> 0.6)
+      i18n (~> 0.6)
+      multi_json (~> 1)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    addressable (2.3.6)
+    ast (2.0.0)
+    astrolabe (1.3.0)
+      parser (>= 2.2.0.pre.3, < 3.0)
+    contentful-management (0.2.1)
+      http (~> 0.6)
+      multi_json (~> 1)
+    crack (0.4.2)
+      safe_yaml (~> 1.0.0)
+    diff-lcs (1.2.5)
+    docile (1.1.5)
+    http (0.6.2)
+      http_parser.rb (~> 0.6.0)
+    http_parser.rb (0.6.0)
+    i18n (0.6.11)
+    multi_json (1.10.1)
+    parser (2.2.0.pre.4)
+      ast (>= 1.1, < 3.0)
+      slop (~> 3.4, >= 3.4.5)
+    powerpack (0.0.9)
+    rainbow (2.0.0)
+    rake (10.3.2)
+    rspec (3.1.0)
+      rspec-core (~> 3.1.0)
+      rspec-expectations (~> 3.1.0)
+      rspec-mocks (~> 3.1.0)
+    rspec-core (3.1.4)
+      rspec-support (~> 3.1.0)
+    rspec-expectations (3.1.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.1.0)
+    rspec-mocks (3.1.1)
+      rspec-support (~> 3.1.0)
+    rspec-support (3.1.0)
+    rubocop (0.26.1)
+      astrolabe (~> 1.3)
+      parser (>= 2.2.0.pre.4, < 3.0)
+      powerpack (~> 0.0.6)
+      rainbow (>= 1.99.1, < 3.0)
+      ruby-progressbar (~> 1.4)
+    ruby-progressbar (1.6.0)
+    safe_yaml (1.0.3)
+    simplecov (0.9.1)
+      docile (~> 1.1.0)
+      multi_json (~> 1.0)
+      simplecov-html (~> 0.8.0)
+    simplecov-html (0.8.0)
+    slop (3.6.0)
+    vcr (2.9.3)
+    webmock (1.18.0)
+      addressable (>= 2.3.6)
+      crack (>= 0.3.2)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.6)
+  rake
+  rspec
+  rubocop
+  simplecov
+  storageroom-to-contentful!
+  vcr
+  webmock

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2014 Contentful GmbH
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -0,0 +1,208 @@
+StorageRoom to Contentful
+=================
+
+## Description
+This tool can be used to migrate data from [StorageRoom](http://storageroomapp.com/) to the [Contentful](https://www.contentful.com) platform.
+
+It exports the data from StorageRoom as JSON to the local hard drive, tries to convert the data to the Contentful data types and allows to recreate the data on Contentful.
+
+
+## Installation
+
+``` bash
+gem install storageroom-to-contentful
+```
+
+This will install a ```storageroom-to-contentful``` executable.
+
+## Usage
+
+To use the tool you need to specify your StorageRoom and Contentful credentials in a YAML file.
+For example in a ```credentials.yml``` file:
+
+``` yaml
+#Contentful
+ACCESS_TOKEN: access_token
+ORGANIZATION_ID: organization_id
+
+#StorageRoom
+ACCOUNT_ID: account_id
+APPLICATION_API_KEY: application_key_id%
+```
+
+Your Contentful access token can be easiest created using the [Contentful Management API - documentation](https://www.contentful.com/developers/documentation/content-management-api/#getting-started)
+
+Once you installed the Gem and created the YAML file with the credentials you can invoke the tool using:
+
+``` bash
+storageroom-to-contentful credentials.yml
+```
+
+You will be presented with a bunch of options:
+
+```
+Actions:
+  1. Export data from StorageRoom to JSON files.
+  2. Convert Storageroom field types to Contentful.
+  3. Import collections to Contentful.
+  4. Import entries to Contentful.
+  5. Publish all entries on Contentful.
+```
+
+
+
+##Step 1 - Export data from StorageRoom to JSON files:
+
+Downloads all data from StorageRoom and saves it locally as JSON files.
+The data will be copied to the current working directory in a sub folder called `data`.
+
+You either manually adjust the data types or try an automatic translation.
+In either case we suggest to put the `data` directory under version control like git and commit after each change.
+
+
+Available types of field on Contentful:
+```
+1. 'Symbol'
+2. 'Text'
+3. 'Integer'
+4. 'Number'
+5. 'Date'
+6. 'Boolean'
+7. 'Link'
+8. 'Array'
+9. 'Object'
+10. 'Location'
+```
+
+All files in ```data/collections``` must be inspected and changed.
+Any occurrence of the *input_type* attribute must changed to a type that is available on Contentful.
+
+#### File & Image
+
+File and Image are equivalent to ```Asset``` in Contentful.
+To create Asset type in Contentful, you must change ```input_type``` to ```Asset```.
+
+#### Select
+
+StorageRoom has a field type: ```select``` which is not directly referred in Contentful.
+As an equivalent it can be treated as a Symbol.
+To create a single ```Symbol``` you must change ```input_type``` to ```Symbol```
+
+Example:
+```
+    "name": "Symbols",
+    "identifier": "symbol_tag",
+    "input_type": "Symbol",
+```
+#### Array
+StorageRoom has a field type: ```Array``` that can not directly be mapped to Contentful.
+As n equivalent it can be treated as a ```Multiple Symbols```.
+To create a multiple ```Symbols``` you must change ```input_type``` to ```Array``` and add an additional parameter:
+```"link": "Symbol"```
+
+
+Example:
+```
+    "name": "Symbols",
+    "identifier": "symbol_tag",
+    "input_type": "Array",
+    "link": "Symbol"
+```
+
+#### Locale
+Entries in Contentful can be localized.
+When importing Entries from StorageRoom to Contentful, some may have attributes that are named as 'locale'.
+Is the value of this attribute not the same as locale ```code``` on Contentful creating the entries will fail.
+You always need to create the locales on Contentful before you start the import.
+
+
+##Association
+ ```
+    1. OneAssociationField (To-One)
+    2. ManyAssociationField (To-Many)
+ ```
+
+#### OneAssociationField (To-One)
+
+To create an ```Entry``` or ```Asset``` Link type, you must change the ```input_type``` to ```Asset``` or ```Entry```.
+
+#### ManyAssociationField (To-Many)
+
+* Entries
+
+To create multiple ```Entries``` Link type, you must change the ```link_type``` to ```Array``` and add an additional parameter:
+```"link_type": "Entry"```
+
+Example:
+```
+    "name": "Entries",
+    "identifier": "entries",
+    "input_type": "Array",
+    "required": true,
+    "unique": null,
+    "link_type": "Entry"
+```
+##Step 2 - Convert Storageroom field types to Contentful:
+
+To convert values of ​​input_type in each collection file (``` data/collections/ ```), select action '2' from the menu.
+
+##Step 3 - Import collections to Contentful:
+Once the exported StorageRoom data is transformed to be compatible with Contentful you can start the import.
+
+Run script again and select action '3' from the menu.
+Enter the name of the new space on Contentful and import the collections as content types.
+
+Once the exported StorageRoom data is transformed to be compatible with Contentful you can start the import.
+
+Run script again and select action '3' from the menu.
+Enter the name of the new space on Contentful and import the collections as content types.
+
+## Convert symbol values to String:
+If the collection has a field of type ```Symbol```, the value of the entry must be strings.
+
+Example:
+#### Field in Collection
+```
+    {
+      "@type": "IntegerField",
+      "name": "Price Range",
+      "identifier": "price_range",
+      "input_type": "Symbol",
+      "required": true,
+      "include_blank_choice": false,
+      "choices": [
+        1,
+        2,
+        3
+      ]
+    },
+```
+#### Entry
+```
+    {
+      "@type": "Restaurant",
+      "price_range": 2,
+    }
+```
+
+##Step 4 - Import entries to Contentful:
+To import all the entries from the exported data to the Contentful platform, select action '4' from the menu.
+
+Each entry will be created with the same StorageRoom id.
+
+#### [Links](https://www.contentful.com/developers/documentation/content-management-api/#links)
+
+If two or more entries are linked the import tool will recreate those relationships.
+
+The entries will be valid once all the required relations are created on Contentful.
+
+##Step 5 - Publish all entries on Contentful:
+To publish all entries, select action '5' from the menu.
+
+If an entry can not be published the tool will print an error message containing the reason(eg. Invalid, ...)
+
+##Script execution:
+
+```
+$ storageroom-to-contentful credentials.yml
+```

data/Rakefile

@@ -0,0 +1,7 @@
+require 'bundler/gem_tasks'
+
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/bin/storageroom-to-contentful

@@ -0,0 +1,27 @@
+#!/usr/bin/env ruby
+require 'yaml'
+require 'i18n'
+
+require_relative '../lib/migrator'
+
+yaml_path = ARGV.shift
+fail 'Missing credentials.yml file, `storageroom-to-contentful credentials.yml`' unless yaml_path
+
+spec = Gem::Specification.find_by_name('storageroom-to-contentful')
+gem_root = spec.gem_dir
+
+puts gem_root
+APP_ROOT = Dir.pwd
+DATA_DIR = "#{APP_ROOT}/data"
+COLLECTIONS_DATA_DIR = "#{DATA_DIR}/collections"
+ENTRIES_DATA_DIR = "#{DATA_DIR}/entries"
+STORAGE_ROOM_URL = 'http://api.storageroomapp.com/accounts/'
+CONTENTFUL_TYPES = %w(Text Integer Number Boolean Symbol Array Entry Asset Date Location Object)
+
+CREDENTIALS = YAML.load_file(File.expand_path(yaml_path))
+
+translations = "#{gem_root}/contenftul_fields_types.yml"
+I18n.load_path << translations
+I18n.enforce_available_locales = false
+
+Migrator.new.run