voog_api 0.0.10 → 0.0.11

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f7f44b299ce7547c3f02afb6ef7c359dc1bb227f
-  data.tar.gz: a11ac4014716a5123f0402e32dc7dbd43b468a47
+  metadata.gz: 5214de3595e958aad72ee6f7b4a903e9075c244b
+  data.tar.gz: 49269b2431b5f8479c771daca4d90517546f6ffa
 SHA512:
-  metadata.gz: c2a7313731a067a53d33b31c39c5d0940dc53d6a150781562850ac46a2e08a937d2c2324e5fe048e46f51dfc1b4410753ecebc5167da3400463686b018d9f0fb
-  data.tar.gz: 31553dcd752fad8a075132e403a50e6df4552b4ca8f2ddc3547ce33688e569b81c67baaf4a9f9a6241507a8972ae00f55d8774e9c6b4b06bfca6fa205edc7624
+  metadata.gz: 69dad9289d6822fb6471850f964f0d7ca29d62b4e19d82a6f24f8b35934c501a0e6e0d3be0b17be15e17d6c9f44db1d3231d92f07914314e7115bedb023da69a
+  data.tar.gz: 96db417ebda65df346de469ad4e17fd437d92ca255d42e2d7ecc3122ba9e9ecd999597345b3862632d490d0b91c52b75b9b61d00d621d8b0a136cccafe043098

data/lib/voog_api/api/articles.rb

@@ -1,33 +1,49 @@
 module Voog
   class API
+
+    # Voog Articles API methods.
+    #
+    # @see http://www.voog.com/developers/api/resources/articles
     module Articles
 
       # List articles
+      #
+      # @see http://www.voog.com/developers/api/resources/articles#get_articles
       def articles(params = {})
         paginate 'articles', {query: params}
       end
 
       # Get a single article
+      #
+      # @see http://www.voog.com/developers/api/resources/articles#get_article
       def article(id, params = {})
         get "articles/#{id}", {query: params}
       end
 
-      # Create a article
+      # Create an article
+      #
+      # @see http://www.voog.com/developers/api/resources/articles#create_article
       def create_article(data)
         post 'articles', data
       end
 
-      # Update a article
+      # Update an article
+      #
+      # @see http://www.voog.com/developers/api/resources/articles#update_article
       def update_article(id, data)
         put "articles/#{id}", data
       end
 
-      # Patch a article
+      # Patch an article
+      #
+      # @see http://www.voog.com/developers/api/resources/articles#patch_article
       def patch_article(id, data)
         patch "articles/#{id}", data
       end
 
-      # Delete a article
+      # Delete an article
+      #
+      # @see http://www.voog.com/developers/api/resources/articles#remove_article
       def delete_article(id)
         delete "articles/#{id}"
       end
@@ -35,6 +51,8 @@ module Voog
       # Update/create a key in article data field
       #
       # @param id [String] key in data field
+      #
+      # @see http://www.voog.com/developers/api/resources/articles#update_article_data_field
       def update_article_data(article_id, id, data)
         put "articles/#{article_id}/data/#{id}", {value: data}
       end
@@ -42,6 +60,8 @@ module Voog
       # Delete a key from article data field
       #
       # @param id [String] key in data field
+      #
+      # @see http://www.voog.com/developers/api/resources/articles#delete_article_custom_field
       def delete_article_data(article_id, id)
         delete "articles/#{article_id}/data/#{id}"
       end
@@ -49,26 +69,36 @@ module Voog
       # Article contents
 
       # List contents for article
+      #
+      # @see http://www.voog.com/developers/api/resources/contents#get_contents
       def article_contents(id, params = {})
         contents(Voog::API::Contents::ParentKind::Article, id, params)
       end
 
       # Get a single content for article
+      #
+      # @see http://www.voog.com/developers/api/resources/contents#get_content
       def article_content(article_id, id, params = {})
         content(Voog::API::Contents::ParentKind::Article, article_id, id, params)
       end
 
-      # Create a article content for article
+      # Create an article content for article
+      #
+      # @see http://www.voog.com/developers/api/resources/contents#create_content
       def create_article_content(article_id, data)
         create_content(Voog::API::Contents::ParentKind::Article, article_id, data)
       end
 
       # Delete a content from article
+      #
+      # @see http://www.voog.com/developers/api/resources/contents#delete_content
       def delete_article_content(article_id, id)
         delete_content(Voog::API::Contents::ParentKind::Article, article_id, id)
       end
 
       # Reorder/move article content inside/between content areas and parent objects
+      #
+      # @see http://www.voog.com/developers/api/resources/contents#relocate_content
       def move_article_content(article_id, id, params = {})
         move_content(Voog::API::Contents::ParentKind::Article, article_id, id, params)
       end

data/lib/voog_api/api/assets.rb

@@ -1,28 +1,42 @@
 module Voog
   class API
+
+    # Voog Assets API methods.
+    #
+    # @see http://www.voog.com/developers/api/resources/assets
     module Assets
 
       # List assets
+      #
+      # @see http://www.voog.com/developers/api/resources/assets#get_assets
       def assets(params = {})
         paginate 'assets', {query: params}
       end
 
       # Get a single asset
+      #
+      # @see http://www.voog.com/developers/api/resources/assets#get_asset
       def asset(id, params = {})
         get "assets/#{id}", {query: params}
       end
 
-      # Create a asset
+      # Create an asset
+      #
+      # @see http://www.voog.com/developers/api/resources/assets#create_asset
       def create_asset(data)
         post 'assets', data
       end
 
-      # Confirm a asset upload
+      # Confirm an asset upload
+      #
+      # @see http://www.voog.com/developers/api/resources/assets#confirm_asset
       def confirm_asset(id)
         put "assets/#{id}/confirm", nil
       end
 
-      # Delete a asset
+      # Delete an asset
+      #
+      # @see http://www.voog.com/developers/api/resources/assets#remove_asset
       def delete_asset(id)
         delete "assets/#{id}"
       end

data/lib/voog_api/api/comments.rb

@@ -1,33 +1,49 @@
 module Voog
   class API
+
+    # Voog article Comments API methods.
+    #
+    # @see http://www.voog.com/developers/api/resources/comments
     module Comments
 
       # List article comments
+      #
+      # @see http://www.voog.com/developers/api/resources/comments#get_comments
       def comments(article_id, params = {})
         paginate "articles/#{article_id}/comments", {query: params}
       end
 
       # Get a single comment for article
+      #
+      # @see http://www.voog.com/developers/api/resources/comments#get_comment
       def comment(article_id, id, params = {})
         get "articles/#{article_id}/comments/#{id}", {query: params}
       end
 
       # Create a comment
+      #
+      # @see http://www.voog.com/developers/api/resources/comments#create_comment
       def create_comment(article_id, data)
         post "articles/#{article_id}/comments", data
       end
 
       # Toggle comment spam flag
+      #
+      # @see http://www.voog.com/developers/api/resources/comments#toggle_spam_comment
       def toggle_spam_comment(article_id, id)
         put "articles/#{article_id}/comments/#{id}/toggle_spam", nil
       end
 
-      # Delete a article comment
+      # Delete an article comment
+      #
+      # @see http://www.voog.com/developers/api/resources/comments#remove_comment
       def delete_comment(article_id, id)
         delete "articles/#{article_id}/comments/#{id}"
       end
 
       # Delete all spam comment for article
+      #
+      # @see http://www.voog.com/developers/api/resources/comments#delete_spam_comments
       def delete_spam_comments(article_id)
         delete "articles/#{article_id}/comments/delete_spam"
       end

data/lib/voog_api/api/content_partials.rb

@@ -1,18 +1,28 @@
 module Voog
   class API
+
+    # Voog Content Partials API methods.
+    #
+    # @see http://www.voog.com/developers/api/resources/content_partials
     module ContentPartials
 
       # List content partials contents
+      #
+      # @see http://www.voog.com/developers/api/resources/content_partials#get_content_partials
       def content_partials(params = {})
         paginate 'content_partials', {query: params}
       end
 
       # Get a single content partial content
+      #
+      # @see http://www.voog.com/developers/api/resources/content_partials#get_content_partial
       def content_partial(id, params = {})
         get "content_partials/#{id}", {query: params}
       end
 
       # Update a content partial content
+      #
+      # @see http://www.voog.com/developers/api/resources/content_partials#update_content_partial
       def update_content_partial(id, data)
         put "content_partials/#{id}", data
       end

data/lib/voog_api/api/contents.rb

@@ -1,5 +1,9 @@
 module Voog
   class API
+
+    # Voog Contents API methods.
+    #
+    # @see http://www.voog.com/developers/api/resources/contents
     module Contents
 
       module ParentKind
@@ -10,26 +14,36 @@ module Voog
       end
 
       # List contents
+      #
+      # @see http://www.voog.com/developers/api/resources/contents#get_contents
       def contents(parent_name, parent_id, params = {})
         paginate "#{parent_name}/#{parent_id}/contents", {query: params}
       end
 
       # Get a single content
+      #
+      # @see http://www.voog.com/developers/api/resources/contents#get_content
       def content(parent_name, parent_id, id, params = {})
         get "#{parent_name}/#{parent_id}/contents/#{id}", {query: params}
       end
 
       # Create a content
+      #
+      # @see http://www.voog.com/developers/api/resources/contents#create_content
       def create_content(parent_name, parent_id, data)
         post "#{parent_name}/#{parent_id}/contents", data
       end
 
       # Delete a content
+      #
+      # @see http://www.voog.com/developers/api/resources/contents#delete_content
       def delete_content(parent_name, parent_id, id)
         delete "#{parent_name}/#{parent_id}/contents/#{id}"
       end
 
       # Reorder/move content inside/between content areas and parent objects
+      #
+      # @see http://www.voog.com/developers/api/resources/contents#relocate_content
       def move_content(parent_name, parent_id, id, params = {})
         put "#{parent_name}/#{parent_id}/contents/#{id}/move", nil, {query: params}
       end

data/lib/voog_api/api/element_definitions.rb

@@ -1,28 +1,42 @@
 module Voog
   class API
+
+    # Voog Element Definitions API methods.
+    #
+    # @see http://www.voog.com/developers/api/resources/element_definitions
     module ElementDefinitions
 
       # List element_definitions
+      #
+      # @see http://www.voog.com/developers/api/resources/element_definitions#get_element_definitions
       def element_definitions(params = {})
         paginate 'element_definitions', {query: params}
       end
 
       # Get a single element_definition
+      #
+      # @see http://www.voog.com/developers/api/resources/element_definitions#get_element_definition
       def element_definition(id, params = {})
         get "element_definitions/#{id}", {query: params}
       end
 
       # Create a element_definition
+      #
+      # @see http://www.voog.com/developers/api/resources/element_definitions#create_element_definition
       def create_element_definition(data)
         post 'element_definitions', data
       end
 
       # Update a element_definition
+      #
+      # @see http://www.voog.com/developers/api/resources/element_definitions#update_element_definition
       def update_element_definition(id, data)
         put "element_definitions/#{id}", data
       end
 
       # Delete a element_definition
+      #
+      # @see http://www.voog.com/developers/api/resources/element_definitions#remove_element_definition
       def delete_element_definition(id)
         delete "element_definitions/#{id}"
       end

data/lib/voog_api/api/elements.rb

@@ -1,33 +1,49 @@
 module Voog
   class API
+
+    # Voog Element Definitions API methods.
+    #
+    # @see http://www.voog.com/developers/api/resources/elements
     module Elements
 
       # List elements
+      #
+      # @see http://www.voog.com/developers/api/resources/elements#get_elements
       def elements(params = {})
         paginate 'elements', {query: params}
       end
 
       # Get a single element
+      #
+      # @see http://www.voog.com/developers/api/resources/elements#get_element
       def element(id, params = {})
         get "elements/#{id}", {query: params}
       end
 
       # Create a element
+      #
+      # @see http://www.voog.com/developers/api/resources/elements#create_element
       def create_element(data)
         post 'elements', data
       end
 
       # Update a element
+      #
+      # @see http://www.voog.com/developers/api/resources/elements#update_element
       def update_element(id, data)
         put "elements/#{id}", data
       end
 
       # Delete a element
+      #
+      # @see http://www.voog.com/developers/api/resources/elements#remove_element
       def delete_element(id)
         delete "elements/#{id}"
       end
 
       # Reorder a elements
+      #
+      # @see http://www.voog.com/developers/api/resources/elements#move_element
       def move_element(element_id, params)
         put "elements/#{element_id}/move", nil, {query: params}
       end
@@ -35,26 +51,36 @@ module Voog
       # Element contents
 
       # List contents for element
+      #
+      # @see http://www.voog.com/developers/api/resources/contents#get_contents
       def element_contents(id, params = {})
         contents(Voog::API::Contents::ParentKind::Element, id, params)
       end
 
       # Get a single content for element
+      #
+      # @see http://www.voog.com/developers/api/resources/contents#get_content
       def element_content(element_id, id, params = {})
         content(Voog::API::Contents::ParentKind::Element, element_id, id, params)
       end
 
       # Create a element content for element
+      #
+      # @see http://www.voog.com/developers/api/resources/contents#create_content
       def create_element_content(element_id, data)
         create_content(Voog::API::Contents::ParentKind::Element, element_id, data)
       end
 
       # Delete a content from element
+      #
+      # @see http://www.voog.com/developers/api/resources/contents#delete_content
       def delete_element_content(element_id, id)
         delete_content(Voog::API::Contents::ParentKind::Element, element_id, id)
       end
 
       # Reorder/move element content inside/between content areas and parent objects
+      #
+      # @see http://www.voog.com/developers/api/resources/contents#relocate_content
       def move_element_content(element_id, id, params = {})
         move_content(Voog::API::Contents::ParentKind::Element, element_id, id, params)
       end

data/lib/voog_api/api/forms.rb

@@ -1,21 +1,38 @@
 module Voog
   class API
+
+    # Voog Forms API methods.
+    #
+    # @see http://www.voog.com/developers/api/resources/forms
     module Forms
 
       # List forms
+      #
+      # @see http://www.voog.com/developers/api/resources/forms#get_forms
       def forms(params = {})
         paginate 'forms', {query: params}
       end
 
       # Get a single form
+      #
+      # @see http://www.voog.com/developers/api/resources/forms#get_form
       def form(id, params = {})
         get "forms/#{id}", {query: params}
       end
 
       # Update a form
+      #
+      # @see http://www.voog.com/developers/api/resources/forms#update_form
       def update_form(id, data)
         put "forms/#{id}", data
       end
+
+      # Delete a form
+      #
+      # @see http://www.voog.com/developers/api/resources/forms#delete_form
+      def delete_form(id)
+        delete "forms/#{id}"
+      end
     end
   end
 end

data/lib/voog_api/api/languages.rb

@@ -1,38 +1,56 @@
 module Voog
   class API
+
+    # Voog Languages API methods.
+    #
+    # @see http://www.voog.com/developers/api/resources/languages
     module Languages
 
       # List languages
+      #
+      # @see http://www.voog.com/developers/api/resources/languages#get_languages
       def languages(params = {})
         paginate 'languages', {query: params}
       end
 
       # Get a single language
+      #
+      # @see http://www.voog.com/developers/api/resources/languages#get_language
       def language(id, params = {})
         get "languages/#{id}", {query: params}
       end
 
       # Create a language
+      #
+      # @see http://www.voog.com/developers/api/resources/languages#create_language
       def create_language(data)
         post 'languages', data
       end
 
       # Update a language
+      #
+      # @see http://www.voog.com/developers/api/resources/languages#update_language
       def update_language(id, data)
         put "languages/#{id}", data
       end
 
       # Delete a language
+      #
+      # @see http://www.voog.com/developers/api/resources/languages#remove_language
       def delete_language(id)
         delete "languages/#{id}"
       end
 
       # Reorder a language
+      #
+      # @see http://www.voog.com/developers/api/resources/languages#move_language
       def move_language(language_id, params)
         put "languages/#{language_id}/move", nil, {query: params}
       end
 
       # Enable language automatic detection for site visitors
+      #
+      # @see http://www.voog.com/developers/api/resources/languages#enable_autodetect
       def enable_language_autodetect
         put "languages/enable_autodetect", nil
       end
@@ -40,26 +58,36 @@ module Voog
       # Language contents
 
       # List contents for language
+      #
+      # @see http://www.voog.com/developers/api/resources/contents#get_contents
       def language_contents(id, params = {})
         contents(Voog::API::Contents::ParentKind::Language, id, params)
       end
 
       # Get a single content for language
+      #
+      # @see http://www.voog.com/developers/api/resources/contents#get_content
       def language_content(language_id, id, params = {})
         content(Voog::API::Contents::ParentKind::Language, language_id, id, params)
       end
 
       # Create a language content for language
+      #
+      # @see http://www.voog.com/developers/api/resources/contents#create_content
       def create_language_content(language_id, data)
         create_content(Voog::API::Contents::ParentKind::Language, language_id, data)
       end
 
       # Delete a content from language
+      #
+      # @see http://www.voog.com/developers/api/resources/contents#delete_content
       def delete_language_content(language_id, id)
         delete_content(Voog::API::Contents::ParentKind::Language, language_id, id)
       end
 
       # Reorder/move language content inside/between content areas and parent objects
+      #
+      # @see http://www.voog.com/developers/api/resources/contents#relocate_content
       def move_language_content(language_id, id, params = {})
         move_content(Voog::API::Contents::ParentKind::Language, language_id, id, params)
       end

data/lib/voog_api/api/layout_assets.rb

@@ -1,18 +1,30 @@
 module Voog
   class API
+
+    # Voog Layout Assets API methods.
+    #
+    # @see http://www.voog.com/developers/api/resources/layout_assets
     module LayoutAssets
       
       # List layouts assets
+      #
+      # @see http://www.voog.com/developers/api/resources/layout_assets#get_layout_assets
       def layout_assets(params = {})
         paginate 'layout_assets', {query: params}
       end
 
       # Get a single layout asset
+      #
+      # @see http://www.voog.com/developers/api/resources/layout_assets#get_layout_asset
       def layout_asset(id, params = {})
         get "layout_assets/#{id}", {query: params}
       end
 
       # Create a layout asset
+      #
+      # @option data [String] :data file content (used only for text-based files, e.g. .css and .js files)
+      # @option data [String] :file path to file location (used for binary files only)
+      # @see http://www.voog.com/developers/api/resources/layout_assets#create_layout_asset
       def create_layout_asset(data)
         if data && data.key?(:file)
           data = data.dup
@@ -24,6 +36,8 @@ module Voog
       end
 
       # Update a layout asset
+      #
+      # @see http://www.voog.com/developers/api/resources/layout_assets#update_layout_asset
       def update_layout_asset(id, data)
         if data && data.key?(:file)
           data[:data] = File.read data.delete(:file)
@@ -32,6 +46,8 @@ module Voog
       end
 
       # Delete a layout asset
+      #
+      # @see http://www.voog.com/developers/api/resources/layout_assets#remove_layout_asset
       def delete_layout_asset(id)
         delete "layout_assets/#{id}"
       end

data/lib/voog_api/api/layouts.rb

@@ -1,28 +1,42 @@
 module Voog
   class API
+
+    # Voog Layouts API methods.
+    #
+    # @see http://www.voog.com/developers/api/resources/layouts
     module Layouts
 
       # List layouts
+      #
+      # @see http://www.voog.com/developers/api/resources/layouts#get_layouts
       def layouts(params = {})
         paginate 'layouts', {query: params}
       end
 
       # Get a single layout
+      #
+      # @see http://www.voog.com/developers/api/resources/layouts#get_layout
       def layout(id, params = {})
         get "layouts/#{id}", {query: params}
       end
 
       # Create a layout
+      #
+      # @see http://www.voog.com/developers/api/resources/layouts#create_layout
       def create_layout(data)
         post 'layouts', data
       end
 
       # Update a layout
+      #
+      # @see http://www.voog.com/developers/api/resources/layouts#update_layout
       def update_layout(id, data)
         put "layouts/#{id}", data
       end
 
       # Delete a layout
+      #
+      # @see http://www.voog.com/developers/api/resources/layouts#remove_layout
       def delete_layout(id)
         delete "layouts/#{id}"
       end