contentful-management 0.0.1.pre

data/Rakefile

@@ -0,0 +1,37 @@
+# -*- encoding: utf-8 -*-
+require 'bundler/gem_tasks'
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'bundler'
+rescue LoadError => e
+  warn e.message
+  warn 'Run `gem install bundler` to install Bundler.'
+  exit 1
+end
+
+begin
+  Bundler.setup(:development)
+rescue Bundler::BundlerError => e
+  warn e.message
+  warn 'Run `bundle install` to install missing gems.'
+  exit e.status_code
+end
+
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new
+
+require 'rubocop/rake_task'
+RuboCop::RakeTask.new
+
+require 'reek/rake/task'
+Reek::Rake::Task.new do |t|
+  t.fail_on_error = false
+end
+
+desc 'Run specs, rubocop and reek'
+task ci: %w(spec reek rubocop)
+
+task test: :spec
+task default: :spec

data/bin/cma-console

@@ -0,0 +1,8 @@
+#!/usr/bin/env ruby
+# -*- encoding: utf-8 -*-
+
+$LOAD_PATH << 'lib'
+require 'contentful/management/client'
+require 'pry'
+
+Pry::CLI.parse_options

data/contentful-management.gemspec

@@ -0,0 +1,33 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'contentful/management/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'contentful-management'
+  spec.version       = Contentful::Management::VERSION
+  spec.authors       = ['Piotr Protas','Tomasz Warkocki','Contentful GmbH (Andreas Tiefenthaler)']
+  spec.email         = ['piotrek@codequest.com','warkocz@gmail.com', 'rubygems@contentful.com']
+  spec.summary       = %q{contentful management api}
+  spec.description   = %q{Ruby client for the https://www.contentful.com Content Management API}
+  spec.homepage      = 'https://github.com/contentful/contentful-management.rb'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'http', '~> 0.6'
+  spec.add_dependency 'multi_json', '~> 1'
+
+  spec.add_development_dependency 'bundler', '~> 1.6'
+  spec.add_development_dependency 'rake'
+
+  spec.add_development_dependency 'rspec', '~> 3'
+  spec.add_development_dependency 'rspec-its'
+  spec.add_development_dependency 'rubocop'
+  spec.add_development_dependency 'reek'
+  spec.add_development_dependency 'vcr'
+  spec.add_development_dependency 'webmock', '~> 1', '>= 1.17.3'
+end

data/examples/blog.rb

@@ -0,0 +1,82 @@
+###
+# This should be and behave like a living example that grows with the code itself.
+#
+# TODO:
+# - localisation
+# - create links between posts and categories
+# - link assets to posts
+# - unpublish all posts
+# - update assets
+# - remove assets
+
+require 'pry'
+
+access_token = 'access token'
+organization = 'organization id'
+
+require 'contentful/management'
+
+client = Contentful::Management::Client.new(access_token)
+
+blog_space = Contentful::Management::Space.create(name: 'Blog', organization_id: organization)
+# blog_space = Contentful::Management::Space.find('zlso53r1zad6')
+
+blog_space.locales.create(name: 'English', code: 'en-US')
+blog_space.locales.create(name: 'German', code: 'de-DE')
+
+category_type = blog_space.content_types.create(name: 'Category')
+category_type.fields.create(id: 'category_name', name: 'Category Name', type: 'Text', localized: true)
+category_type.fields.create(id: 'category_description', name: 'Category Description', type: 'Text', localized: true)
+
+post_type = blog_space.content_types.create(name: 'Post')
+post_type.fields.create(id: 'post_title', name: 'Post Title', type: 'Text', localized: true)
+post_type.fields.create(id: 'post_author', name: 'Post Author', type: 'Text', localized: true)
+post_type.fields.create(id: 'post_body', name: 'Post Body', type: 'Text', localized: true)
+
+categories = Contentful::Management::Field.new
+categories.id = 'post_category'
+categories.type = 'link'
+categories.link_type = 'Entry'
+post_type.fields.create(id: 'post_categories', name: 'Post Categories', type: 'Array', items: categories)
+
+# category_type = blog_space.content_types.find('3bMvEx9ROwEQCmyGcYOI8c')
+# post_type = blog_space.content_types.find('1D93omOM0YocSsGwY8wY6u')
+
+post_type.activate
+category_type.activate
+
+sleep 10 # prevent race conditions
+
+puts "creating categories"
+entries = []
+entries << category_type.entries.create(category_name: 'Misc', category_description: 'Misc stuff')
+entries << category_type.entries.create(category_name: 'Serious', category_description: 'Serious stuff')
+
+# TODO: add links to categories
+entries << post_type.entries.create(post_title: 'First Post', post_author: 'Andy', post_body: 'Letterpress sustainable authentic, disrupt semiotics actually kitsch. Direct trade Cosby sweater Austin, Pitchfork flexitarian small batch authentic roof party 8-bit YOLO literally Neutra pour-over American Apparel dreamcatcher. High Life distillery cliche YOLO, flexitarian four loko put a bird on it plaid Marfa Shoreditch seitan Echo Park bicycle rights Pinterest PBR. Drinking vinegar Banksy gastropub, stumptown occupy farm-to-table Blue Bottle tattooed Truffaut single-origin coffee iPhone locavore pug. Blue Bottle cray quinoa farm-to-table Bushwick tousled. Kitsch beard tousled, American Apparel XOXO vegan readymade Pitchfork church-key 3 wolf moon direct trade lo-fi. Food truck try-hard deep v salvia raw denim.', locale: 'en-US')
+entries << post_type.entries.create(post_title: 'Second Post', post_author: 'Andy', post_body: "Fixie hashtag pour-over disrupt raw denim bespoke semiotics, typewriter Shoreditch messenger bag Thundercats chillwave DIY. Forage hoodie squid hella Kickstarter Thundercats, Banksy scenester flannel disrupt PBR&B fap chia. Small batch Brooklyn Williamsburg hella viral banh mi selfies organic. Semiotics Brooklyn skateboard cray messenger bag Echo Park. PBR&B High Life wolf meh, typewriter Bushwick VHS Cosby sweater mlkshk farm-to-table. Fingerstache readymade PBR literally, fixie letterpress swag fap. Authentic distillery banh mi, forage pork belly craft beer locavore DIY 90's iPhone 3 wolf moon synth.", locale: 'de-DE')
+
+asset = blog_space.assets.new
+
+asset.title_with_locales = {'en-US' => 'title picture 1', 'de-DE' => 'title picture 2'}
+asset.description_with_locales = {'en-US' => 'space_asset_desc', 'de-DE' => 'space_asset_desc'}
+
+file1 = Contentful::Management::File.new
+file1.properties[:contentType] = 'image/jpeg'
+file1.properties[:fileName] = 'pic1.jpg'
+file1.properties[:upload] = 'https://upload.wikimedia.org/wikipedia/commons/c/c7/Gasometer_Berlin_Sch%C3%B6neberg_2011.jpg'
+
+file2 = Contentful::Management::File.new
+file2.properties[:contentType] = 'image/jpeg'
+file2.properties[:fileName] = 'pic1.jpg'
+file2.properties[:upload] = 'https://upload.wikimedia.org/wikipedia/commons/b/bd/Gasometer_Schoeneberg_innen.jpg'
+
+asset.file_with_locales = {'en-US' => file1, 'de-DE' => file2}
+asset.save
+
+entries.map(&:publish)
+
+puts "Press any key to destroy space"
+gets
+
+blog_space.destroy

data/examples/content_types.rb

@@ -0,0 +1,45 @@
+require 'pry'
+
+access_token = 'access token'
+organization = 'organization id'
+
+require 'contentful/management'
+
+
+client = Contentful::Management::Client.new(access_token)
+space = Contentful::Management::Space.create(name: 'MySpace', organization_id: organization)
+
+p space.content_types
+
+type1 = space.content_types.create(name: 'ContentType 1')
+
+p space.content_types.all
+
+field = Contentful::Management::Field.new
+field.id = 'such_content'
+field.name = 'Such Content'
+field.type = 'Text' #content types maybe as symbol?
+
+type2 = space.content_types.new
+type2.name = 'ContentType 2'
+type2.fields = [field]
+type2.save
+
+field2 = Contentful::Management::Field.new
+field2.id = 'wow_content'
+field2.name = 'Wow Content'
+field2.type = 'Location' #content types maybe as symbol?
+
+
+type2.update(name: 'whoat', fields: [field, field2])
+
+type2.fields.add(field2)
+
+type2.activate
+p type2.active?
+type2.deactivate
+
+type1.destroy
+
+#clean up afterwards!
+space.destroy

data/examples/create_space.rb

@@ -0,0 +1,35 @@
+require 'pry'
+
+access_token = 'access token'
+organization = 'organization id'
+
+require 'contentful/management'
+
+client = Contentful::Management::Client.new(access_token)
+
+spaces = Contentful::Management::Space.all
+
+my_space = Contentful::Management::Space.create(name: 'MySpace', organization_id: organization)
+
+my_space.update(name: 'MyNewSpace')
+
+dat_space = Contentful::Management::Space.find(my_space.id)
+
+
+dat_space.locales.create(name: 'English', code: 'en-US')
+
+locales = dat_space.locales
+# locales.map(&:destroy) # not implemented yet?
+
+dat_space.destroy
+
+
+# XXX: This does not set the organization_id when a space should be created
+#
+your_space = Contentful::Management::Space.new
+your_space.organization = organization
+your_space.name = 'YourSpace'
+your_space.save
+
+
+your_space.destroy

data/lib/contentful/management.rb

@@ -0,0 +1,12 @@
+# -*- encoding: utf-8 -*-
+require 'contentful/management/version'
+require 'contentful/management/support'
+require 'contentful/management/resource'
+require 'contentful/management/client'
+require 'contentful/management/space'
+
+module Contentful
+  module Management
+    # Your code goes here...
+  end
+end

data/lib/contentful/management/array.rb

@@ -0,0 +1,35 @@
+# -*- encoding: utf-8 -*-
+require_relative 'resource'
+require_relative 'resource/array_like'
+
+module Contentful
+  module Management
+    # Resource Class for Arrays (e.g. search results)
+    # https://www.contentful.com/developers/documentation/content-delivery-api/#arrays
+    # It also provides an #each method and includes Ruby's Enumerable module (gives you methods like #min, #first, etc)
+    class Array
+      DEFAULT_LIMIT = 100
+
+      include Contentful::Management::Resource
+      include Contentful::Management::Resource::SystemProperties
+      include Contentful::Management::Resource::ArrayLike
+
+      property :total, :integer
+      property :limit, :integer
+      property :skip, :integer
+      property :items
+
+      # Simplifies pagination
+      def next_page
+        if request
+          new_skip = (skip || 0) + (limit || DEFAULT_LIMIT)
+          new_request = request.copy
+          new_request.query[:skip] = new_skip
+          new_request.get
+        else
+          false
+        end
+      end
+    end
+  end
+end

data/lib/contentful/management/asset.rb

@@ -0,0 +1,163 @@
+# -*- encoding: utf-8 -*-
+require_relative 'resource'
+require_relative 'resource/fields'
+
+module Contentful
+  module Management
+    class Asset
+
+      FIELDS_COERCIONS = {
+          title: :hash,
+          description: :hash,
+          file: Contentful::Management::File
+      }
+
+      def self.fields_coercions
+        FIELDS_COERCIONS
+      end
+
+      include Contentful::Management::Resource
+      include Contentful::Management::Resource::Fields
+      include Contentful::Management::Resource::SystemProperties
+      include Contentful::Management::Resource::Refresher
+
+      def self.all(space_id)
+        request = Request.new("/#{ space_id }/assets")
+        response = request.get
+        result = ResourceBuilder.new(self, response, {}, {})
+        result.run
+      end
+
+      def self.find(space_id, asset_id)
+        request = Request.new("/#{ space_id }/assets/#{ asset_id }")
+        response = request.get
+        result = ResourceBuilder.new(self, response, {}, {})
+        result.run
+      end
+
+      def self.create(space_id, attributes)
+        asset = self.new
+        asset.instance_variable_set(:@fields, attributes[:fields] || {})
+        asset.locale = attributes[:locale] if attributes[:locale]
+        asset.title = attributes[:title] if attributes[:title]
+        asset.description = attributes[:description] if attributes[:description]
+        asset.file = attributes[:file] if attributes[:file]
+
+        request = Request.new("/#{ space_id }/assets/#{ attributes[:id] || ''}", { fields: asset.fields_for_query })
+        response = attributes[:id].nil? ? request.post : request.put
+        result = ResourceBuilder.new(self, response, {}, {}).run
+        result.process_files if result.is_a? self
+        result
+      end
+
+      def process_files
+        instance_variable_get(:@fields).keys.each do |locale|
+          request = Request.new("/#{ space.id }/assets/#{ id }/files/#{ locale }/process", {}, id = nil, version: sys[:version])
+          request.put
+        end
+      end
+
+      def update(attributes)
+        self.title = attributes[:title] if attributes[:title]
+        self.description = attributes[:description] if attributes[:description]
+        self.file = attributes[:file] if attributes[:file]
+        request = Request.new("/#{ space.id }/assets/#{ id }", { fields: fields_for_query }, id = nil, version: sys[:version])
+        response = request.put
+        result = ResourceBuilder.new(self, response, {}, {}).run
+        refresh_data(result)
+      end
+
+      def save
+        if id.nil?
+          new_instance = self.class.create(self.sys[:space].id, { fields: instance_variable_get(:@fields) })
+          refresh_data(new_instance)
+        else
+          update(title: title, description: description, file: file)
+        end
+      end
+
+      def destroy
+        request = Request.new("/#{ space.id }/assets/#{ id }")
+        response = request.delete
+        if response.status == :no_content
+          return true
+        else
+          result = ResourceBuilder.new(self, response, {}, {})
+          result.run
+        end
+      end
+
+      def publish
+        request = Request.new("/#{ space.id }/assets/#{ id }/published", {}, id = nil, version: sys[:version])
+        response = request.put
+        result = ResourceBuilder.new(self, response, {}, {}).run
+        refresh_data(result)
+      end
+
+      def unpublish
+        request = Request.new("/#{ space.id }/assets/#{ id }/published", {}, id = nil, version: sys[:version])
+        response = request.delete
+        result = ResourceBuilder.new(self, response, {}, {}).run
+        refresh_data(result)
+      end
+
+      def archive
+        request = Request.new("/#{ space.id }/assets/#{ id }/archived", {}, id = nil, version: sys[:version])
+        response = request.put
+        result = ResourceBuilder.new(self, response, {}, {}).run
+        refresh_data(result)
+      end
+
+      def unarchive
+        request = Request.new("/#{ space.id }/assets/#{ id }/archived", {}, id = nil, version: sys[:version])
+        response = request.delete
+        result = ResourceBuilder.new(self, response, {}, {}).run
+        refresh_data(result)
+      end
+
+      def published?
+        !sys[:publishedAt].nil?
+      end
+
+      def archived?
+        !sys[:archivedAt].nil?
+      end
+
+      def locale
+        sys && sys[:locale] ? sys[:locale] : default_locale
+      end
+
+      def fields_for_query
+        self.class.fields_coercions.keys.each_with_object({}) do |field_name, results|
+          results[field_name] = @fields.each_with_object({}) do |(locale, fields), field_results|
+            field_results[locale] = field_name == :file ? (fields[field_name] ? fields[field_name].properties : nil) : fields[field_name]
+          end
+        end
+      end
+
+      # Returns the image url of an asset
+      # Allows you to pass in the following options for image resizing:
+      #   :width
+      #   :height
+      #   :format
+      #   :quality
+      # See https://www.contentful.com/developers/documentation/content-delivery-api/#image-asset-resizing
+      def image_url(options = {})
+        query = {
+            w: options[:w] || options[:width],
+            h: options[:h] || options[:height],
+            fm: options[:fm] || options[:format],
+            q: options[:q] || options[:quality]
+        }.reject { |_k, v| v.nil? }
+
+        if query.empty?
+          file.url
+        else
+          "#{ file.url }?#{ URI.encode_www_form(query) }"
+        end
+      end
+
+    end
+  end
+end
+