voog_api 0.0.7

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 4e20e5667103808724ed2df2060430cb06585194
+  data.tar.gz: 87276171f2c2ad169c6241aac2a53e9d3e35a00c
+SHA512:
+  metadata.gz: 85efc4a527b459c8787b6639dafc1552ea640ed3af02fc2e4568f28b729d0607e4e4ba3ab4e1877251853f3ff6af40354abb31b5e817d18cf37499a14d9fde6a
+  data.tar.gz: d0cf82aad10c84fcf89cd169a01e78263242adb8588771faaef74f3be4e449b9a78d96fd6895b317016a58964e109bf7af251c9b1b02f8de5ee2a69f6ab1f325

data/.gitignore

@@ -0,0 +1,19 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+.ruby-version
+.ruby-gemset

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format progress

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+gem 'rest-client'
+gemspec

data/Guardfile

@@ -0,0 +1,5 @@
+guard :rspec do
+  watch(%r{^spec/.+_spec\.rb$})
+  watch(%r{^lib/(.+)\.rb$})     { |m| "spec/#{m[1]}_spec.rb" }
+  watch('spec/helper.rb')  { "spec" }
+end

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Priit Haamer
+
+MIT License
+
+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.markdown

@@ -0,0 +1,55 @@
+# voog.rb
+
+Ruby toolkit for the [Voog](http://www.voog.com) API.
+
+Learn more at the [Voog developer central](http://www.voog.com/developers/api) and by reading the [Voog API documentation](http://www.voog.com/developers/api).
+
+## Getting started
+
+Either add this line to your application's `Gemfile`:
+
+```
+gem 'voog_api'
+```
+
+And then execute:
+
+```
+$ bundle
+```
+
+Or install it yourself as:
+
+```
+$ gem install voog_api
+```
+
+## API token
+
+To generate your personal **API token** for your site, go to `Account` -> `My profile` and click on "Generate new API token".
+
+## Initializing the client
+
+All requests to the Voog API are done through the `Voog::Client` class, which takes two parameters: site host and API token.
+
+```ruby
+client = Voog::Client.new('example.com', 'afcf30182aecfc8155d390d7d4552d14')
+```
+
+Making an API request is as simple as calling a single method on the client:
+
+```ruby
+client.layouts
+```
+
+Most responses from the client are `Response` objects that provide access to the API resource objects by using both dot and hash notation:
+
+```ruby
+layout = client.layout(1)
+
+puts layout.title
+# => "Front page"
+
+puts layout[:title]
+# => "Front page"
+```

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/lib/voog_api/api/articles.rb

@@ -0,0 +1,77 @@
+module Voog
+  class API
+    module Articles
+
+      # List articles
+      def articles(params = {})
+        get 'articles', {query: params}
+      end
+
+      # Get a single article
+      def article(id, params = {})
+        get "articles/#{id}", {query: params}
+      end
+
+      # Create a article
+      def create_article(data)
+        post 'articles', data
+      end
+
+      # Update a article
+      def update_article(id, data)
+        put "articles/#{id}", data
+      end
+
+      # Patch a article
+      def patch_article(id, data)
+        patch "articles/#{id}", data
+      end
+
+      # Delete a article
+      def delete_article(id)
+        delete "articles/#{id}"
+      end
+
+      # Update/create a key in article data field
+      #
+      # @params id [String] key in data field
+      def update_article_data(article_id, id, data)
+        put "articles/#{article_id}/data/#{id}", {value: data}
+      end
+
+      # Delete a key from article data field
+      #
+      # @params id [String] key in data field
+      def delete_article_data(article_id, id)
+        delete "articles/#{article_id}/data/#{id}"
+      end
+
+      # Article contents
+
+      # List contents for article
+      def article_contents(id, params = {})
+        contents(Voog::API::Contents::ParentKind::Article, id, params)
+      end
+
+      # Get a single content for article
+      def article_content(article_id, id, params = {})
+        content(Voog::API::Contents::ParentKind::Article, article_id, id, params)
+      end
+
+      # Create a article content for article
+      def create_article_content(article_id, data)
+        create_content(Voog::API::Contents::ParentKind::Article, article_id, data)
+      end
+
+      # Delete a content from article
+      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
+      def move_article_content(article_id, id, params = {})
+        move_content(Voog::API::Contents::ParentKind::Article, article_id, id, params)
+      end
+    end
+  end
+end

data/lib/voog_api/api/assets.rb

@@ -0,0 +1,31 @@
+module Voog
+  class API
+    module Assets
+
+      # List assets
+      def assets(params = {})
+        get 'assets', {query: params}
+      end
+
+      # Get a single asset
+      def asset(id, params = {})
+        get "assets/#{id}", {query: params}
+      end
+
+      # Create a asset
+      def create_asset(data)
+        post 'assets', data
+      end
+
+      # Confirm a asset upload
+      def confirm_asset(id)
+        put "assets/#{id}/confirm", nil
+      end
+
+      # Delete a asset
+      def delete_asset(id)
+        delete "assets/#{id}"
+      end
+    end
+  end
+end

data/lib/voog_api/api/comments.rb

@@ -0,0 +1,36 @@
+module Voog
+  class API
+    module Comments
+
+      # List article comments
+      def comments(article_id, params = {})
+        get "articles/#{article_id}/comments", {query: params}
+      end
+
+      # Get a single comment for article
+      def comment(article_id, id, params = {})
+        get "articles/#{article_id}/comments/#{id}", {query: params}
+      end
+
+      # Create a comment
+      def create_comment(article_id, data)
+        post "articles/#{article_id}/comments", data
+      end
+
+      # Toggle comment spam flag
+      def toggle_spam_comment(article_id, id)
+        put "articles/#{article_id}/comments/#{id}/toggle_spam", nil
+      end
+
+      # Delete a article comment
+      def delete_comment(article_id, id)
+        delete "articles/#{article_id}/comments/#{id}"
+      end
+
+      # Delete all spam comment for article
+      def delete_spam_comments(article_id)
+        delete "articles/#{article_id}/comments/delete_spam"
+      end
+    end
+  end
+end

data/lib/voog_api/api/content_partials.rb

@@ -0,0 +1,21 @@
+module Voog
+  class API
+    module ContentPartials
+
+      # List content partials contents
+      def content_partials(params = {})
+        get 'content_partials', {query: params}
+      end
+
+      # Get a single content partial content
+      def content_partial(id, params = {})
+        get "content_partials/#{id}", {query: params}
+      end
+
+      # Update a content partial content
+      def update_content_partial(id, data)
+        put "content_partials/#{id}", data
+      end
+    end
+  end
+end

data/lib/voog_api/api/contents.rb

@@ -0,0 +1,38 @@
+module Voog
+  class API
+    module Contents
+
+      module ParentKind
+        Article = 'articles'
+        Element = 'elements'
+        Language = 'languages'
+        Page = 'pages'
+      end
+
+      # List contents
+      def contents(parent_name, parent_id, params = {})
+        get "#{parent_name}/#{parent_id}/contents", {query: params}
+      end
+
+      # Get a single content
+      def content(parent_name, parent_id, id, params = {})
+        get "#{parent_name}/#{parent_id}/contents/#{id}", {query: params}
+      end
+
+      # Create a content
+      def create_content(parent_name, parent_id, data)
+        post "#{parent_name}/#{parent_id}/contents", data
+      end
+
+      # Delete a 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
+      def move_content(parent_name, parent_id, id, params = {})
+        put "#{parent_name}/#{parent_id}/contents/#{id}/move", nil, {query: params}
+      end
+    end
+  end
+end

data/lib/voog_api/api/element_definitions.rb

@@ -0,0 +1,31 @@
+module Voog
+  class API
+    module ElementDefinitions
+
+      # List element_definitions
+      def element_definitions(params = {})
+        get 'element_definitions', {query: params}
+      end
+
+      # Get a single element_definition
+      def element_definition(id, params = {})
+        get "element_definitions/#{id}", {query: params}
+      end
+
+      # Create a element_definition
+      def create_element_definition(data)
+        post 'element_definitions', data
+      end
+
+      # Update a element_definition
+      def update_element_definition(id, data)
+        put "element_definitions/#{id}", data
+      end
+
+      # Delete a element_definition
+      def delete_element_definition(id)
+        delete "element_definitions/#{id}"
+      end
+    end
+  end
+end

data/lib/voog_api/api/elements.rb

@@ -0,0 +1,63 @@
+module Voog
+  class API
+    module Elements
+
+      # List elements
+      def elements(params = {})
+        get 'elements', {query: params}
+      end
+
+      # Get a single element
+      def element(id, params = {})
+        get "elements/#{id}", {query: params}
+      end
+
+      # Create a element
+      def create_element(data)
+        post 'elements', data
+      end
+
+      # Update a element
+      def update_element(id, data)
+        put "elements/#{id}", data
+      end
+
+      # Delete a element
+      def delete_element(id)
+        delete "elements/#{id}"
+      end
+
+      # Reorder a elements
+      def move_element(element_id, params)
+        put "elements/#{element_id}/move", nil, {query: params}
+      end
+
+      # Element contents
+
+      # List contents for element
+      def element_contents(id, params = {})
+        contents(Voog::API::Contents::ParentKind::Element, id, params)
+      end
+
+      # Get a single content for element
+      def element_content(element_id, id, params = {})
+        content(Voog::API::Contents::ParentKind::Element, element_id, id, params)
+      end
+
+      # Create a element content for element
+      def create_element_content(element_id, data)
+        create_content(Voog::API::Contents::ParentKind::Element, element_id, data)
+      end
+
+      # Delete a content from element
+      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
+      def move_element_content(element_id, id, params = {})
+        move_content(Voog::API::Contents::ParentKind::Element, element_id, id, params)
+      end
+    end
+  end
+end

data/lib/voog_api/api/forms.rb

@@ -0,0 +1,21 @@
+module Voog
+  class API
+    module Forms
+
+      # List forms
+      def forms(params = {})
+        get 'forms', {query: params}
+      end
+
+      # Get a single form
+      def form(id, params = {})
+        get "forms/#{id}", {query: params}
+      end
+
+      # Update a form
+      def update_form(id, data)
+        put "forms/#{id}", data
+      end
+    end
+  end
+end

data/lib/voog_api/api/languages.rb

@@ -0,0 +1,68 @@
+module Voog
+  class API
+    module Languages
+
+      # List languages
+      def languages(params = {})
+        get 'languages', {query: params}
+      end
+
+      # Get a single language
+      def language(id, params = {})
+        get "languages/#{id}", {query: params}
+      end
+
+      # Create a language
+      def create_language(data)
+        post 'languages', data
+      end
+
+      # Update a language
+      def update_language(id, data)
+        put "languages/#{id}", data
+      end
+
+      # Delete a language
+      def delete_language(id)
+        delete "languages/#{id}"
+      end
+
+      # Reorder a language
+      def move_language(language_id, params)
+        put "languages/#{language_id}/move", nil, {query: params}
+      end
+
+      # Enable language automatic detection for site visitors
+      def enable_language_autodetect
+        put "languages/enable_autodetect", nil
+      end
+
+      # Language contents
+
+      # List contents for language
+      def language_contents(id, params = {})
+        contents(Voog::API::Contents::ParentKind::Language, id, params)
+      end
+
+      # Get a single content for language
+      def language_content(language_id, id, params = {})
+        content(Voog::API::Contents::ParentKind::Language, language_id, id, params)
+      end
+
+      # Create a language content for language
+      def create_language_content(language_id, data)
+        create_content(Voog::API::Contents::ParentKind::Language, language_id, data)
+      end
+
+      # Delete a content from language
+      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
+      def move_language_content(language_id, id, params = {})
+        move_content(Voog::API::Contents::ParentKind::Language, language_id, id, params)
+      end
+    end
+  end
+end

data/lib/voog_api/api/layout_assets.rb

@@ -0,0 +1,39 @@
+module Voog
+  class API
+    module LayoutAssets
+      
+      # List layouts assets
+      def layout_assets(params = {})
+        get 'layout_assets', {query: params}
+      end
+
+      # Get a single layout asset
+      def layout_asset(id, params = {})
+        get "layout_assets/#{id}", {query: params}
+      end
+
+      # Create a layout asset
+      def create_layout_asset(data)
+        if data && data.key?(:file)
+          data[:file] = Faraday::UploadIO.new(data[:file], data[:content_type])
+          options = {multipart: true}
+        end
+
+        post 'layout_assets', data, (options || {})
+      end
+
+      # Update a layout asset
+      def update_layout_asset(id, data)
+        if data && data.key?(:file)
+          data[:data] = File.read data.delete(:file)
+        end
+        put "layout_assets/#{id}", data
+      end
+
+      # Delete a layout asset
+      def delete_layout_asset(id)
+        delete "layout_assets/#{id}"
+      end
+    end
+  end
+end

data/lib/voog_api/api/layouts.rb

@@ -0,0 +1,31 @@
+module Voog
+  class API
+    module Layouts
+
+      # List layouts
+      def layouts(params = {})
+        get 'layouts', {query: params}
+      end
+
+      # Get a single layout
+      def layout(id, params = {})
+        get "layouts/#{id}", {query: params}
+      end
+
+      # Create a layout
+      def create_layout(data)
+        post 'layouts', data
+      end
+
+      # Update a layout
+      def update_layout(id, data)
+        put "layouts/#{id}", data
+      end
+
+      # Delete a layout
+      def delete_layout(id)
+        delete "layouts/#{id}"
+      end
+    end
+  end
+end

data/lib/voog_api/api/media_sets.rb

@@ -0,0 +1,36 @@
+module Voog
+  class API
+    module MediaSets
+
+      # List media_sets
+      def media_sets(params = {})
+        get 'media_sets', {query: params}
+      end
+
+      # Get a single media_set
+      def media_set(id, params = {})
+        get "media_sets/#{id}", {query: params}
+      end
+
+      # Create a media_set
+      def create_media_set(data)
+        post 'media_sets', data
+      end
+
+      # Update a media_set
+      def update_media_set(id, data)
+        put "media_sets/#{id}", data
+      end
+
+      # Delete a media_set
+      def delete_media_set(id)
+        delete "media_sets/#{id}"
+      end
+
+      # Add assets to media_set
+      def media_set_add_assets(media_set_id, data)
+        put "media_sets/#{media_set_id}/add_assets", data
+      end
+    end
+  end
+end

data/lib/voog_api/api/nodes.rb

@@ -0,0 +1,26 @@
+module Voog
+  class API
+    module Nodes
+
+      # List nodes
+      def nodes(params = {})
+        get 'nodes', {query: params}
+      end
+
+      # Get a single node
+      def node(id, params = {})
+        get "nodes/#{id}", {query: params}
+      end
+
+      # Update a node
+      def update_node(id, data)
+        put "nodes/#{id}", data
+      end
+
+      # Reorder a node
+      def move_node(node_id, params)
+        put "nodes/#{node_id}/move", nil, {query: params}
+      end
+    end
+  end
+end