voog_api 0.0.7

data/lib/voog_api/api/pages.rb

@@ -0,0 +1,77 @@
+module Voog
+  class API
+    module Pages
+
+      # List pages
+      def pages(params = {})
+        get 'pages', {query: params}
+      end
+
+      # Get a single page
+      def page(id, params = {})
+        get "pages/#{id}", {query: params}
+      end
+
+      # Create a page
+      def create_page(data)
+        post 'pages', data
+      end
+
+      # Update a page
+      def update_page(id, data)
+        put "pages/#{id}", data
+      end
+
+      # Patch a page
+      def patch_page(id, data)
+        patch "pages/#{id}", data
+      end
+
+      # Delete a page
+      def delete_page(id)
+        delete "pages/#{id}"
+      end
+
+      # Update/create a key in page data field
+      #
+      # @params id [String] key in data field
+      def update_page_data(page_id, id, data)
+        put "pages/#{page_id}/data/#{id}", {value: data}
+      end
+
+      # Delete a key from page data field
+      #
+      # @params id [String] key in data field
+      def delete_page_data(page_id, id)
+        delete "pages/#{page_id}/data/#{id}"
+      end
+
+      # Page contents
+
+      # List contents for page
+      def page_contents(id, params = {})
+        contents(Voog::API::Contents::ParentKind::Page, id, params)
+      end
+
+      # Get a single content for page
+      def page_content(page_id, id, params = {})
+        content(Voog::API::Contents::ParentKind::Page, page_id, id, params)
+      end
+
+      # Create a page content for page
+      def create_page_content(page_id, data)
+        create_content(Voog::API::Contents::ParentKind::Page, page_id, data)
+      end
+
+      # Delete a content from page
+      def delete_page_content(page_id, id)
+        delete_content(Voog::API::Contents::ParentKind::Page, page_id, id)
+      end
+
+      # Reorder/move page content inside/between content areas and parent objects
+      def move_page_content(page_id, id, params = {})
+        move_content(Voog::API::Contents::ParentKind::Page, page_id, id, params)
+      end
+    end
+  end
+end

data/lib/voog_api/api/people.rb

@@ -0,0 +1,16 @@
+module Voog
+  class API
+    module People
+
+      # List people
+      def people(params = {})
+        get 'people', {query: params}
+      end
+
+      # Get a single person
+      def person(id, params = {})
+        get "people/#{id}", {query: params}
+      end
+    end
+  end
+end

data/lib/voog_api/api/site.rb

@@ -0,0 +1,35 @@
+module Voog
+  class API
+    module Site
+
+      # Get site attributes
+      def site(params = {})
+        get 'site', {query: params}
+      end
+
+      # Update a site
+      def update_site(data)
+        put "site", data
+      end
+
+      # Patch a site
+      def patch_site(data)
+        patch "site", data
+      end
+
+      # Update/create a key in site data field
+      #
+      # @params id [String] key in data field
+      def update_site_data(id, data)
+        put "site/data/#{id}", {value: data}
+      end
+
+      # Delete a key from site data field
+      #
+      # @params id [String] key in data field
+      def delete_site_data(id)
+        delete "site/data/#{id}"
+      end
+    end
+  end
+end

data/lib/voog_api/api/tags.rb

@@ -0,0 +1,26 @@
+module Voog
+  class API
+    module Tags
+
+      # List tags
+      def tags(params = {})
+        get 'tags', {query: params}
+      end
+
+      # Get a single tag
+      def tag(id, params = {})
+        get "tags/#{id}", {query: params}
+      end
+
+      # Update a tag
+      def update_tag(id, data)
+        put "tags/#{id}", data
+      end
+
+      # Delete a tag
+      def delete_tag(id)
+        delete "tags/#{id}"
+      end
+    end
+  end
+end

data/lib/voog_api/api/texts.rb

@@ -0,0 +1,21 @@
+module Voog
+  class API
+    module Texts
+
+      # List text contents
+      def texts(params = {})
+        get 'texts', {query: params}
+      end
+
+      # Get a single text content
+      def text(id, params = {})
+        get "texts/#{id}", {query: params}
+      end
+
+      # Update a text content
+      def update_text(id, data)
+        put "texts/#{id}", data
+      end
+    end
+  end
+end

data/lib/voog_api/api/tickets.rb

@@ -0,0 +1,26 @@
+module Voog
+  class API
+    module Tickets
+
+      # List form tickets
+      def tickets(form_id, params = {})
+        get "forms/#{form_id}/tickets", {query: params}
+      end
+
+      # Get a single ticket for form
+      def ticket(form_id, id, params = {})
+        get "forms/#{form_id}/tickets/#{id}", {query: params}
+      end
+
+      # Delete a form ticket
+      def delete_ticket(form_id, id)
+        delete "forms/#{form_id}/tickets/#{id}"
+      end
+
+      # Delete all spam ticket for form
+      def delete_spam_tickets(form_id)
+        delete "forms/#{form_id}/tickets/delete_spam"
+      end
+    end
+  end
+end

data/lib/voog_api/client.rb

@@ -0,0 +1,140 @@
+require 'json'
+require 'sawyer'
+
+require 'voog_api/api/articles'
+require 'voog_api/api/assets'
+require 'voog_api/api/comments'
+require 'voog_api/api/content_partials'
+require 'voog_api/api/contents'
+require 'voog_api/api/element_definitions'
+require 'voog_api/api/elements'
+require 'voog_api/api/forms'
+require 'voog_api/api/languages'
+require 'voog_api/api/layouts'
+require 'voog_api/api/layout_assets'
+require 'voog_api/api/media_sets'
+require 'voog_api/api/nodes'
+require 'voog_api/api/site'
+require 'voog_api/api/pages'
+require 'voog_api/api/people'
+require 'voog_api/api/tags'
+require 'voog_api/api/texts'
+require 'voog_api/api/tickets'
+
+module Voog
+  
+  class Client
+    
+    include Voog::API::Articles
+    include Voog::API::Assets
+    include Voog::API::Comments
+    include Voog::API::ContentPartials
+    include Voog::API::Contents
+    include Voog::API::ElementDefinitions
+    include Voog::API::Elements
+    include Voog::API::Forms
+    include Voog::API::Languages
+    include Voog::API::Layouts
+    include Voog::API::LayoutAssets
+    include Voog::API::MediaSets
+    include Voog::API::Nodes
+    include Voog::API::Pages
+    include Voog::API::People
+    include Voog::API::Site
+    include Voog::API::Tags
+    include Voog::API::Texts
+    include Voog::API::Tickets
+
+    attr_reader :api_token, :host
+
+    def initialize(host = Voog.host, api_token = Voog.api_token, options = {})
+      @host = host
+      @api_token = api_token
+      @options = options
+      @raise_on_error = options.fetch(:raise_on_error, true)
+    end
+
+    def get(url, options = {})
+      request :get, url, nil, options
+    end
+    
+    def post(url, data, options = {})
+      request :post, url, data, options
+    end
+
+    def put(url, data, options = {})
+      request :put, url, data, options
+    end
+
+    def patch(url, data, options = {})
+      request :patch, url, data, options
+    end
+
+    def delete(url, options = {})
+      request :delete, url, nil, options
+    end
+
+    def head(url, options = {})
+      request :head, url, nil, options
+    end
+    
+    def api_endpoint
+      "http://#{host}/admin/api"
+    end
+    
+    def agent
+      @agent ||= Sawyer::Agent.new(api_endpoint, sawyer_options) do |http|
+        http.headers[:content_type] = 'application/json'
+        http.headers[:accept] = 'application/json'
+        http.headers[:user_agent] = 'Voog.rb Ruby wrapper'
+        http.headers[:x_api_token] = @api_token
+      end
+    end
+
+    def multipart_agent
+      Faraday.new do |faraday|
+        faraday.request :multipart
+        faraday.response :raise_error if @raise_on_error
+        faraday.adapter :net_http
+
+        faraday.headers['X_API_TOKEN'] = @api_token
+        faraday.headers['User-Agent'] = 'Voog.rb Ruby wrapper'
+      end
+    end
+    
+    def last_response
+      @last_response
+    end
+
+    def parse_response(response)
+      JSON.parse(response).inject({}){|memo,(k,v)| memo[k.to_sym] = v; memo}
+    end
+    
+    private
+    
+    def request(method, path, data, options = {})
+      multipart = options.fetch(:multipart, false) && (method == :post)
+
+      @last_response = response = multipart ? \
+        multipart_agent.post("#{api_endpoint}/#{path}", data) : \
+        agent.call(method, URI.encode(path.to_s), data, options)
+      if multipart
+        parse_response(response.body)
+      else
+        response.data
+      end
+    end
+
+    def sawyer_options(multipart = false)
+      faraday = Faraday.new do |faraday|
+        faraday.response :raise_error if @raise_on_error
+        faraday.adapter :net_http
+      end
+      opts = {
+        links_parser: Sawyer::LinkParsers::Simple.new,
+        faraday: faraday
+      }
+      opts
+    end
+  end
+end

data/lib/voog_api/version.rb

@@ -0,0 +1,3 @@
+module Voog
+  VERSION = '0.0.7'
+end

data/lib/voog_api.rb

@@ -0,0 +1,46 @@
+require 'voog_api/version'
+require 'voog_api/client'
+
+module Voog
+
+  class << self
+    
+    attr_accessor :host, :api_token
+
+    def client(options = {})
+      unless host.nil? && api_token.nil?
+        Voog::Client.new(host, api_token, options)
+      else
+        nil
+      end
+    end
+
+    def configure
+      yield self
+      true
+    end
+
+    if RUBY_VERSION >= '1.9'
+      
+      def respond_to_missing?(method_name, include_private = false)
+        client.respond_to?(method_name, include_private)
+      end
+      
+    end
+
+    if RUBY_VERSION < '1.9'
+      
+      def respond_to?(method_name, include_private = false)
+        client.respond_to?(method_name, include_private) || super
+      end
+      
+    end
+
+    private
+
+    def method_missing(method_name, *args, &block)
+      return super unless client.respond_to?(method_name)
+      client.send(method_name, *args, &block)
+    end
+  end
+end

data/spec/fixtures/articles/article.json

@@ -0,0 +1,37 @@
+{
+  "id": 2,
+  "title": "How I wrote my first article",
+  "path": "how-i-wrote-my-first-article",
+  "comments_count": 0,
+  "publishing": true,
+  "published": true,
+  "data": {},
+  "created_at": "2014-01-23T09:22:04.000Z",
+  "updated_at": "2014-01-23T09:22:04.000Z",
+  "published_at": "2014-01-23T09:22:04.000Z",
+  "url": "http://voog.test/admin/api/articles/2",
+  "public_url": "http://voog.test/blog/how-i-wrote-my-first-article",
+  "contents_url": "http://voog.test/admin/api/articles/2/contents",
+  "comments_url": "http://voog.test/admin/api/site/articles/2/comments",
+  "page": {
+    "id": 3,
+    "content_type": "blog",
+    "created_at": "2014-01-23T09:19:04.000Z",
+    "updated_at": "2014-01-23T09:19:04.000Z",
+    "published_at": "2014-01-23T09:19:04.000Z",
+    "url": "http://voog.test/admin/api/pages/3"
+  },
+  "language": {
+    "id": 1,
+    "code": "en",
+    "title": "ENG",
+    "created_at": "2014-01-23T09:19:04.000Z",
+    "updated_at": "2014-01-23T09:19:04.000Z",
+    "url": "http://voog.test/admin/api/languages/1"
+  },
+  "author": {
+    "id": 1,
+    "name": "John Smith",
+    "url": "http://voog.test/admin/api/people/1"
+  }
+}

data/spec/fixtures/articles/articles.json

@@ -0,0 +1,75 @@
+[
+  {
+    "id": 2,
+    "title": "How I wrote my first article",
+    "path": "how-i-wrote-my-first-article",
+    "comments_count": 0,
+    "publishing": true,
+    "published": true,
+    "data": {},
+    "created_at": "2014-01-23T09:22:04.000Z",
+    "updated_at": "2014-01-23T09:22:04.000Z",
+    "published_at": "2014-01-23T09:22:04.000Z",
+    "url": "http://voog.test/admin/api/articles/2",
+    "public_url": "http://voog.test/blog/how-i-wrote-my-first-article",
+    "contents_url": "http://voog.test/admin/api/articles/2/contents",
+    "comments_url": "http://voog.test/admin/api/site/articles/2/comments",
+    "page": {
+      "id": 3,
+      "content_type": "blog",
+      "created_at": "2014-01-23T09:19:04.000Z",
+      "updated_at": "2014-01-23T09:19:04.000Z",
+      "published_at": "2014-01-23T09:19:04.000Z",
+      "url": "http://voog.test/admin/api/pages/3"
+    },
+    "language": {
+      "id": 1,
+      "code": "en",
+      "title": "ENG",
+      "created_at": "2014-01-23T09:19:04.000Z",
+      "updated_at": "2014-01-23T09:19:04.000Z",
+      "url": "http://voog.test/admin/api/languages/1"
+    },
+    "author": {
+      "id": 1,
+      "name": "John Smith",
+      "url": "http://voog.test/admin/api/people/1"
+    }
+  }, {
+    "id": 1,
+    "title": "Having sample news pieces?",
+    "path": "having-sample-news-pieces",
+    "comments_count": 0,
+    "publishing": true,
+    "published": true,
+    "data": {},
+    "created_at": "2014-01-23T09:19:04.000Z",
+    "updated_at": "2014-01-23T09:19:04.000Z",
+    "published_at": "2014-01-23T09:19:04.000Z",
+    "url": "http://voog.test/admin/api/articles/1",
+    "public_url": "http://voog.test/blog/having-sample-news-pieces",
+    "contents_url": "http://voog.test/admin/api/articles/1/contents",
+    "comments_url": "http://voog.test/admin/api/site/articles/1/comments",
+    "page": {
+      "id": 3,
+      "content_type": "blog",
+      "created_at": "2014-01-23T09:19:04.000Z",
+      "updated_at": "2014-01-23T09:19:04.000Z",
+      "published_at": "2014-01-23T09:19:04.000Z",
+      "url": "http://voog.test/admin/api/pages/3"
+    },
+    "language": {
+      "id": 1,
+      "code": "en",
+      "title": "ENG",
+      "created_at": "2014-01-23T09:19:04.000Z",
+      "updated_at": "2014-01-23T09:19:04.000Z",
+      "url": "http://voog.test/admin/api/languages/1"
+    },
+    "author": {
+      "id": 1,
+      "name": "John Smith",
+      "url": "http://voog.test/admin/api/people/1"
+    }
+  }
+]

data/spec/fixtures/assets/asset.json

@@ -0,0 +1,24 @@
+{
+  "id": 1,
+  "filename": "Screen Shot 2014-01-28 at 10.53.26.png",
+  "content_type": "image/png",
+  "size": 95708,
+  "extension": "png",
+  "type": "image",
+  "created_at": "2014-02-04T10:55:28.000Z",
+  "updated_at": "2014-02-04T10:55:30.000Z",
+  "url": "http://voog.test/admin/api/assets/1",
+  "original_url": "http://media.voog.com/0000/0000/0001/photos/Screen%20Shot%202014-01-28%20at%2010.53.26.png",
+  "thumbnail_url": "http://media.voog.com/0000/0000/0001/photos/Screen%20Shot%202014-01-28%20at%2010.53.26_large.jpg",
+  "medium_thumbnail_url": "http://media.voog.com/0000/0000/0001/photos/Screen%20Shot%202014-01-28%20at%2010.53.26_medium.jpg",
+  "width": 999,
+  "height": 569,
+  "media_sets": [{
+    "id": 1,
+    "title": "",
+    "created_at": "2014-01-16T08:04:27.000Z",
+    "updated_at": "2014-01-16T08:04:27.000Z",
+    "url": "http://media.voog.com/admin/api/media_sets/1",
+    "add_assets_url": "http://media.voog.com/admin/api/media_sets/1/add_assets"
+  }]
+}

data/spec/fixtures/assets/assets.json

@@ -0,0 +1,29 @@
+[
+  {
+    "id": 2,
+    "filename": "report.pdf",
+    "content_type": "application/pdf",
+    "size": 36657,
+    "extension": "pdf",
+    "type": "document",
+    "created_at": "2014-02-04T14:37:41.000Z",
+    "updated_at": "2014-02-04T14:37:41.000Z",
+    "url": "http://voog.test/admin/api/assets/2",
+    "original_url": "http://media.voog.com/0000/0000/0001/files/report.pdf"
+  }, {
+    "id": 1,
+    "filename": "Screen Shot 2014-01-28 at 10.53.26.png",
+    "content_type": "image/png",
+    "size": 95708,
+    "extension": "png",
+    "type": "image",
+    "created_at": "2014-02-04T10:55:28.000Z",
+    "updated_at": "2014-02-04T10:55:30.000Z",
+    "url": "http://voog.test/admin/api/assets/1",
+    "original_url": "http://media.voog.com/0000/0000/0001/photos/Screen%20Shot%202014-01-28%20at%2010.53.26.png",
+    "thumbnail_url": "http://media.voog.com/0000/0000/0001/photos/Screen%20Shot%202014-01-28%20at%2010.53.26_large.jpg",
+    "medium_thumbnail_url": "http://media.voog.com/0000/0000/0001/photos/Screen%20Shot%202014-01-28%20at%2010.53.26_medium.jpg",
+    "width": 999,
+    "height": 569
+  }
+]

data/spec/fixtures/comments/comment.json

@@ -0,0 +1,21 @@
+{
+  "id": 2,
+  "author": "I'm a Spammer!",
+  "body": "Buy something!",
+  "spam": false,
+  "created_at": "2014-02-07T10:54:08.000Z",
+  "updated_at": "2014-02-07T10:54:08.000Z",
+  "url": "http://voog.test/admin/api/articles/1/comments/2",
+  "article": {
+    "id": 1,
+    "title": "How I wrote my first article",
+    "created_at": "2014-02-07T10:56:07.000Z",
+    "updated_at": "2014-02-07T10:56:07.000Z",
+    "url": "http://voog.test/admin/api/articles/1",
+    "public_url": "http://voog.test/blog/how-i-wrote-my-first-article"
+  },
+  "author_email": "spam@spam.com",
+  "user_ip": "23.81.71.154",
+  "user_agent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10.8; rv:27.0) Gecko/20100101 Firefox/27.0",
+  "referrer": "http://voog.test/blog/how-i-wrote-my-first-article"
+}

data/spec/fixtures/comments/comments.json

@@ -0,0 +1,35 @@
+[
+  {
+    "id": 2,
+    "author": "I'm a Spammer!",
+    "body": "Buy something!",
+    "spam": false,
+    "created_at": "2014-02-07T10:54:08.000Z",
+    "updated_at": "2014-02-07T10:56:07.000Z",
+    "url": "http://voog.test/admin/api/articles/1/comments/2",
+    "article": {
+      "id": 1,
+      "title": "How I wrote my first article",
+      "created_at": "2014-02-07T10:56:07.000Z",
+      "updated_at": "2014-02-07T10:56:07.000Z",
+      "url": "http://voog.test/admin/api/articles/1",
+      "public_url": "http://voog.test/blog/how-i-wrote-my-first-article"
+    }
+  }, {
+    "id": 1,
+    "author": "Me",
+    "body": "Hi!\r\n\r\nThis is a comment!!",
+    "spam": false,
+    "created_at": "2014-02-06T15:53:01.000Z",
+    "updated_at": "2014-02-06T15:53:01.000Z",
+    "url": "http://voog.test/admin/api/articles/1/comments/1",
+    "article": {
+      "id": 1,
+      "title": "How I wrote my first article",
+      "created_at": "2014-02-07T10:56:07.000Z",
+      "updated_at": "2014-02-07T10:56:07.000Z",
+      "url": "http://voog.test/admin/api/articles/1",
+      "public_url": "http://voog.test/blog/how-i-wrote-my-first-article"
+    }
+  }
+]

data/spec/fixtures/content_partials/content_partial.json

@@ -0,0 +1,27 @@
+{
+  "id": 2,
+  "content_type": "video",
+  "created_at": "2014-05-30T10:22:04.000Z",
+  "updated_at": "2014-05-30T10:22:04.000Z",
+  "url": "http://voog.test/admin/api/content_partials/2",
+  "content": {
+    "id": 3,
+    "name": "body",
+    "position": 1,
+    "created_at": "2014-05-30T10:22:04.000Z",
+    "updated_at": "2014-05-30T10:22:04.000Z",
+    "url": "http://voog.test/admin/api/pages/1/contents/3"
+  },
+  "parent": {
+    "id": 1,
+    "title": "Home page",
+    "type": "page",
+    "created_at": "2014-01-13T09:19:04.000Z",
+    "updated_at": "2014-01-13T09:19:04.000Z",
+    "url": "http://voog.test/admin/api/pages/1"
+  },
+  "body": "<iframe></iframe>",
+  "metainfo": {
+    "type": "video"
+  }
+}