cxf 0.0.1

data/lib/user/content/blocks.rb

@@ -0,0 +1,109 @@
+# frozen_string_literal: true
+module Blocks
+  # === Duplicate block.
+  # Duplicate a block.
+  #
+  # ==== Parameters
+  # id:: (Integer) -- block id.
+  # data:: (Hash) -- Data to be submitted.
+  #
+  # ==== Example
+  #     data = { options: [] }
+  #     @data = @cxf_user.duplicate_block(1, data.to_json)
+  def duplicate_block(id, data)
+    @client.raw('post', "/content/blocks/#{id}/duplicate", nil, data)
+  end
+
+  # === Get blocks.
+  # Get a collection of blocks.
+  #
+  # ==== Parameters
+  # options:: (Hash) -- List of Resource Collection Options shown above can be used as parameter.
+  # use_post:: (Boolean) -- Variable to determine if the request is by 'post' or 'get' functions.
+  #
+  # ==== First Example
+  #     @data = @cxf_user.get_blocks
+  #
+  # ==== Second Example
+  #     options = {
+  #       fields: 'id, slug'
+  #     }
+  #     @data = @cxf_user.get_blocks(options)
+  #
+  # ==== Third Example
+  #     options = {
+  #       fields: 'id, slug'
+  #     }
+  #     @data = @cxf_user.get_blocks(options, true)
+  def get_blocks(options = nil, use_post = true)
+    get_query_results('/content/blocks', options, use_post)
+  end
+
+  # === Get block.
+  # Get a block info.
+  #
+  # ==== Parameters
+  # id:: (Integer) -- block id.
+  # options:: (Hash) -- List of Resource Collection Options shown above can be used as parameter.
+  #
+  # ==== First Example
+  #     @data = @cxf_user.get_block(1)
+  #
+  # ==== Second Example
+  #     options = {
+  #       fields: 'id, slug'
+  #     }
+  #     @data = @cxf_user.get_block(1, options)
+  def get_block(id, options = nil)
+    @client.raw('get', "/content/blocks/#{id}", options)
+  end
+
+  # === Create block.
+  # Create a block with data.
+  #
+  # ==== Parameters
+  # data:: (Hash) -- Data to be submitted.
+  #
+  # ==== Example
+  #     data = {
+  #       user_id: 1,
+  #       slug: "new-block",
+  #       block_template_id: 1
+  #     }
+  #
+  #     options = { fields: 'id,slug' }
+  #
+  #     @data = @cxf_user.create_block(data, options)
+  def create_block(data, options = nil)
+    @client.raw('post', '/content/blocks', options, data_transform(data))
+  end
+
+  # === Update block.
+  # Update a block info.
+  #
+  # ==== Parameters
+  # id:: (Integer) -- block id.
+  # data:: (Hash) -- Data to be submitted.
+  #
+  # ==== Example
+  #     data = {
+  #       user_id: 1,
+  #       slug: 'new-block'
+  #     }
+  #     @data = @cxf_user.update_block(5, data)
+  def update_block(id, data, options = nil)
+    @client.raw('put', "/content/blocks/#{id}", options, data_transform(data))
+  end
+
+  # === Delete block.
+  # Delete a block.
+  #
+  # ==== Parameters
+  # id:: (Integer) -- block id.
+  #
+  # ==== Example
+  #     @data = @cxf_user.delete_block(6)
+  def delete_block(id)
+    @client.raw('delete', "/content/blocks/#{id}")
+  end
+end

data/lib/user/content/content.rb

@@ -0,0 +1,174 @@
+# frozen_string_literal: true
+require_relative './assets'
+require_relative './stories'
+require_relative './print_versions'
+require_relative './story_templates'
+require_relative './blocks'
+require_relative './block_templates'
+require_relative './instances'
+require_relative './templates'
+
+module Content
+  include Assets
+  include Stories
+  include PrintVersions
+  include StoryTemplates
+  include Blocks
+  include BlockTemplates
+  include Instances
+  include Templates
+
+  # === Get public images url.
+  # Get public images url.
+  #
+  # ==== Example
+  #     @data = @cxf_user.get_public_images_url
+  def get_public_images_url
+    @client.raw('get', '/content/public-images-url')
+  end
+
+  ##
+  # == Keywords
+  #
+
+  # === Get keywords.
+  # Get a collection of keywords.
+  #
+  # ==== Parameters
+  # options:: (Hash) -- List of Resource Collection Options shown above can be used as parameter.
+  #
+  # ==== First Example
+  #     @data = @cxf_user.get_keywords
+  #
+  # ==== Second Example
+  #     options = { fields: 'title' }
+  #     @data = @cxf_user.get_keywords(options)
+  def get_keywords(options = nil)
+    @client.raw('get', '/content/keywords', options)
+  end
+
+  # === Get keyword.
+  # Get a keyword.
+  #
+  # ==== Parameters
+  # id:: (Integer) -- Keyword id.
+  #
+  def get_keyword(id)
+    @client.raw('get', "/content/keywords/#{id}")
+  end
+
+  # === Create keyword.
+  # Create a keyword with data.
+  #
+  # ==== Parameters
+  # data:: (Hash) -- Data to be submitted.
+  #
+  # ==== Example
+  #     data = {
+  #       title: 'New Keyword'
+  #     }
+  #     @data = @cxf_user.create_keyword(data.to_json)
+  def create_keyword(data)
+    @client.raw('post', '/content/keywords', nil, data)
+  end
+
+  # === Update keyword.
+  # Update a keyword info.
+  #
+  # ==== Parameters
+  # id:: (Integer) -- Keyword id.
+  # data:: (Hash) -- Data to be submitted.
+  #
+  # ==== Example
+  #
+  def update_keyword(id, data)
+    # FIXME: Keyword controller doesnt receive data
+    @client.raw('put', "/content/keywords/#{id}", nil, data)
+  end
+
+  ##
+  # == Stages
+  #
+
+  # === Get stages.
+  # Get a collection of stages.
+  #
+  # ==== Parameters
+  # options:: (Hash) -- List of Resource Collection Options shown above can be used as parameter.
+  #
+  # ==== First Example
+  #     @data = @cxf_user.get_stages
+  #
+  # ==== Second Example
+  #     options = { fields: 'title' }
+  #     @data = @cxf_user.get_stages(options)
+  def get_stages(options = nil)
+    @client.raw('get', '/content/stages', options)
+  end
+
+  # === Get stage.
+  # Get a stage.
+  #
+  # ==== Parameters
+  # id:: (Integer) -- Stage id.
+  #
+  # ==== Example
+  #     @data = @cxf_user.get_stage(1)
+  def get_stage(id)
+    @client.raw('get', "/content/stages/#{id}")
+  end
+
+  # === Create stage.
+  # Create a stage with data.
+  #
+  # ==== Parameters
+  # data:: (Hash) -- Data to be submitted.
+  #
+  # ==== Example
+  #     config_json = {
+  #       count: 1
+  #     }
+  #     event_json = {
+  #       rset: 'DTSTART:20190214T000000Z',
+  #       duration: 1
+  #     }
+  #     data = {
+  #       title: 'New Stage',
+  #       description: 'New Stage Description',
+  #       config_json: config_json.to_json,
+  #       event_json: event_json.to_json
+  #     }
+  #     @data = @cxf_user.create_stage(data.to_json)
+  def create_stage(data)
+    @client.raw('post', '/content/stages', nil, data)
+  end
+
+  # === Update stage.
+  # Update a stage info.
+  #
+  # ==== Parameters
+  # id:: (Integer) -- Stage id.
+  # data:: (Hash) -- Data to be submitted.
+  #
+  # ==== Example
+  #     config_json = {
+  #       count: 2
+  #     }
+  #     event_json = {
+  #       rset: 'DTSTART:20190214T000000Z',
+  #       duration: 2
+  #     }
+  #     data = {
+  #       stageProps: {
+  #         title: 'New Stage Modified',
+  #         description: 'New Stage Description Modified'
+  #       },
+  #       config_json: config_json.to_json,
+  #       event_json: event_json.to_json
+  #     }
+  #     @data = @cxf_user.update_stage(3, data.to_json)
+  def update_stage(id, data)
+    # TODO: Inform StageController.update method has been modified
+    @client.raw('put', "/content/stages/#{id}", nil, data)
+  end
+end

data/lib/user/content/instances.rb

@@ -0,0 +1,121 @@
+# frozen_string_literal: true
+
+module Instances
+  # === Duplicate instance.
+  # Duplicate a instance.
+  #
+  # ==== Parameters
+  # id:: (Integer) -- instance id.
+  # data:: (Hash) -- Data to be submitted.
+  #
+  # ==== Example
+  #     data = { options: [] }
+  #     @data = @cxf_user.duplicate_instance(1, data.to_json)
+  def duplicate_instance(id, data)
+    @client.raw('post', "/content/instances/#{id}/duplicate", nil, data)
+  end
+
+  # === Get instances.
+  # Get a collection of instances.
+  #
+  # ==== Parameters
+  # options:: (Hash) -- List of Resource Collection Options shown above can be used as parameter.
+  # use_post:: (Boolean) -- Variable to determine if the request is by 'post' or 'get' functions.
+  #
+  # ==== First Example
+  #     @data = @cxf_user.get_instances
+  #
+  # ==== Second Example
+  #     options = {
+  #       fields: 'id, slug'
+  #     }
+  #     @data = @cxf_user.get_instances(options)
+  #
+  # ==== Third Example
+  #     options = {
+  #       fields: 'id, slug'
+  #     }
+  #     @data = @cxf_user.get_instances(options, true)
+  def get_instances(options = nil, use_post = true)
+    get_query_results('/content/instances', options, use_post)
+  end
+
+  # === Get instance.
+  # Get a instance info.
+  #
+  # ==== Parameters
+  # id:: (Integer) -- instance id.
+  # options:: (Hash) -- List of Resource Collection Options shown above can be used as parameter.
+  #
+  # ==== First Example
+  #     @data = @cxf_user.get_instance(1)
+  #
+  # ==== Second Example
+  #     options = {
+  #       fields: 'id, slug'
+  #     }
+  #     @data = @cxf_user.get_instance(1, options)
+  def get_instance(id, options = nil)
+    @client.raw('get', "/content/instances/#{id}", options)
+  end
+
+  # === Create instance.
+  # Create a instance with data.
+  #
+  # ==== Parameters
+  # data:: (Hash) -- Data to be submitted.
+  #
+  # ==== Example
+  #     data = {
+  #       user_id: 1,
+  #       slug: "new-instance",
+  #       instance_template_id: 1
+  #     }
+  #
+  #     options = { fields: 'id,slug' }
+  #
+  #     @data = @cxf_user.create_instance(data, options)
+  def create_instance(data, options = nil)
+    @client.raw('post', '/content/instances', options, data_transform(data))
+  end
+
+  # === Create instance version.
+  # Create a instance version with data.
+  #
+  # ==== Parameters
+  # id:: (Integer) -- instance id.
+  # data:: (Hash) -- Data to be submitted.
+  # options:: (Hash) -- List of Resource Collection Options shown above can be used as parameter.
+  def create_instance_version(id, data, options = nil)
+    @client.raw('post', "/content/instances/#{id}/print-version", options, data_transform(data))
+  end
+
+  # === Update instance.
+  # Update a instance info.
+  #
+  # ==== Parameters
+  # id:: (Integer) -- instance id.
+  # data:: (Hash) -- Data to be submitted.
+  #
+  # ==== Example
+  #     data = {
+  #       user_id: 1,
+  #       slug: 'new-instance'
+  #     }
+  #     @data = @cxf_user.update_instance(5, data)
+  def update_instance(id, data, options = nil)
+    @client.raw('put', "/content/instances/#{id}", options, data_transform(data))
+  end
+
+  # === Delete instance.
+  # Delete a instance.
+  #
+  # ==== Parameters
+  # id:: (Integer) -- instance id.
+  #
+  # ==== Example
+  #     @data = @cxf_user.delete_instance(6)
+  def delete_instance(id)
+    @client.raw('delete', "/content/instances/#{id}")
+  end
+end

data/lib/user/content/print_versions.rb

@@ -0,0 +1,129 @@
+# frozen_string_literal: true
+
+module PrintVersions
+  # === Get print versions.
+  # Get a collection of print versions.
+  #
+  # ==== Parameters
+  # options:: (Hash) -- List of Resource Collection Options shown above can be used as parameter.
+  # use_post:: (Boolean) -- Variable to determine if the request is by 'post' or 'get' functions.
+  #
+  # ==== First Example
+  #     @data = @cxf_user.get_print_versions
+  #
+  # ==== Second Example
+  #     options = {
+  #       fields: 'id, title'
+  #     }
+  #     @data = @cxf_user.get_print_versions(options)
+  #
+  # ==== Third Example
+  #     options = {
+  #       fields: 'id, title'
+  #     }
+  #     @data = @cxf_user.get_print_versions(options, true)
+  def get_print_versions(options = nil, use_post = true)
+    get_query_results('/content/print-versions', options, use_post)
+  end
+
+  # === Get print version.
+  # Get a print version info.
+  #
+  # ==== Parameters
+  # id:: (Integer) -- print version id.
+  # options:: (Hash) -- List of Resource Collection Options shown above can be used as parameter.
+  #
+  # ==== First Example
+  #     @data = @cxf_user.get_print_version(1)
+  #
+  # ==== Second Example
+  #     options = {
+  #       fields: 'id, title'
+  #     }
+  #     @data = @cxf_user.get_print_version(1, options)
+  def get_print_version(id, options = nil)
+    @client.raw('get', "/content/print-versions/#{id}", options)
+  end
+
+  # === Create print version.
+  # Create a print version with data.
+  #
+  # ==== Parameters
+  # data:: (Hash) -- Data to be submitted.
+  #
+  # ==== Example
+  #     data = {
+  #       title: 'New print',
+  #       slug: 'new-print',
+  #       social_metadata: 'social metadata'
+  #     }
+  #     @data = @cxf_user.create_print_version(data)
+  def create_print_version(data, options = nil)
+    @client.raw('post', '/content/print-versions', options, data_transform(data))
+  end
+
+  # === CHECK THIS ===
+  # def create_print_version_from_instance(id, data, options = nil)
+  #   @client.raw('post', "/content/print-versions/#{id}/print-version", options, data_transform(data))
+  # end
+
+  # === Update print version.
+  # Update a print version info.
+  #
+  # ==== Parameters
+  # id:: (Integer) -- print version id.
+  # data:: (Hash) -- Data to be submitted.
+  #
+  # ==== Example
+  #     data = {
+  #       title: 'New print Modified',
+  #       slug: 'new-print'
+  #     }
+  #     @data = @cxf_user.update_print_version(5, data)
+  def update_print_version(id, data, options = nil)
+    @client.raw('put', "/content/print-versions/#{id}", options, data_transform(data))
+  end
+
+  # === Delete print version.
+  # Delete a print version.
+  #
+  # ==== Parameters
+  # id:: (Integer) -- print version id.
+  #
+  # ==== Example
+  #     @data = @cxf_user.delete_print_version(6)
+  def delete_print_version(id)
+    @client.raw('delete', "/content/print-versions/#{id}")
+  end
+
+  # === Duplicate print version.
+  # Duplicate a print version.
+  #
+  # ==== Parameters
+  # id:: (Integer) -- print version id.
+  # data:: (Hash) -- Data to be submitted.
+  #
+  # ==== Example
+  #     data = { options: [] }
+  #     @data = @cxf_user.duplicate_print_version(1, data.to_json)
+  def duplicate_print_version(id, data)
+    @client.raw('post', "/content/print-versions/#{id}/duplicate", nil, data)
+  end
+
+  # === Publish print version.
+  # Publish a print version.
+  #
+  # ==== Parameters
+  # id:: (Integer) -- print version id.
+  # data:: (Hash) -- Data to be submitted.
+  #
+  # ==== Example
+  #     data = {
+  #       title: 'New print Modified',
+  #       slug: 'new-print'
+  #     }
+  #     @data = @cxf_user.publish_print_version(1, data.to_json)
+  def publish_print_version(id, data)
+    @client.raw('put', "/content/print-versions/#{id}/publish", nil, data)
+  end
+end

data/lib/user/content/stories.rb

@@ -0,0 +1,110 @@
+# frozen_string_literal: true
+
+module Stories
+  # === Duplicate story.
+  # Duplicate a story.
+  #
+  # ==== Parameters
+  # id:: (Integer) -- Story id.
+  # data:: (Hash) -- Data to be submitted.
+  #
+  # ==== Example
+  #     data = { options: [] }
+  #     @data = @cxf_user.duplicate_story(1, data.to_json)
+  def duplicate_story(id, data)
+    @client.raw('post', "/content/stories/#{id}/duplicate", nil, data)
+  end
+
+  # === Get stories.
+  # Get a collection of stories.
+  #
+  # ==== Parameters
+  # options:: (Hash) -- List of Resource Collection Options shown above can be used as parameter.
+  # use_post:: (Boolean) -- Variable to determine if the request is by 'post' or 'get' functions.
+  #
+  # ==== First Example
+  #     @data = @cxf_user.get_stories
+  #
+  # ==== Second Example
+  #     options = {
+  #       fields: 'id, slug'
+  #     }
+  #     @data = @cxf_user.get_stories(options)
+  #
+  # ==== Third Example
+  #     options = {
+  #       fields: 'id, slug'
+  #     }
+  #     @data = @cxf_user.get_stories(options, true)
+  def get_stories(options = nil, use_post = true)
+    get_query_results('/content/stories', options, use_post)
+  end
+
+  # === Get story.
+  # Get a story info.
+  #
+  # ==== Parameters
+  # id:: (Integer) -- Story id.
+  # options:: (Hash) -- List of Resource Collection Options shown above can be used as parameter.
+  #
+  # ==== First Example
+  #     @data = @cxf_user.get_story(1)
+  #
+  # ==== Second Example
+  #     options = {
+  #       fields: 'id, slug'
+  #     }
+  #     @data = @cxf_user.get_story(1, options)
+  def get_story(id, options = nil)
+    @client.raw('get', "/content/stories/#{id}", options)
+  end
+
+  # === Create story.
+  # Create a story with data.
+  #
+  # ==== Parameters
+  # data:: (Hash) -- Data to be submitted.
+  #
+  # ==== Example
+  #     data = {
+  #       user_id: 1,
+  #       slug: "new-story",
+  #       story_template_id: 1
+  #     }
+  #
+  #     options = { fields: 'id,slug' }
+  #
+  #     @data = @cxf_user.create_story(data, options)
+  def create_story(data, options = nil)
+    @client.raw('post', '/content/stories', options, data_transform(data))
+  end
+
+  # === Update story.
+  # Update a story info.
+  #
+  # ==== Parameters
+  # id:: (Integer) -- Story id.
+  # data:: (Hash) -- Data to be submitted.
+  #
+  # ==== Example
+  #     data = {
+  #       user_id: 1,
+  #       slug: 'new-story'
+  #     }
+  #     @data = @cxf_user.update_story(5, data)
+  def update_story(id, data, options = nil)
+    @client.raw('put', "/content/stories/#{id}", options, data_transform(data))
+  end
+
+  # === Delete story.
+  # Delete a story.
+  #
+  # ==== Parameters
+  # id:: (Integer) -- Story id.
+  #
+  # ==== Example
+  #     @data = @cxf_user.delete_story(6)
+  def delete_story(id)
+    @client.raw('delete', "/content/stories/#{id}")
+  end
+end