weeblycloud 1.0.0

data/lib/weeblycloud/blogpost.rb

@@ -0,0 +1,28 @@
+require "weeblycloud/cloudresource"
+require "weeblycloud/saveable"
+require "weeblycloud/deleteable"
+
+module Weeblycloud
+
+  # Represents a BlogPost resource.
+  # https://cloud-developer.weebly.com/blog-post.html
+  class BlogPost < CloudResource
+    include Deleteable, Saveable
+
+    def initialize(user_id, site_id, blog_id, blog_post_id, data = nil)
+      @user_id = user_id.to_i
+      @site_id = site_id.to_i
+      @blog_id = blog_id.to_i
+      @blog_post_id = blog_post_id.to_i
+      @endpoint = "user/#{@user_id}/site/#{@site_id}/blog/#{@blog_id}/post/#{@blog_post_id}"
+
+      super(data)
+    end
+
+    # Returns the blog_post_id
+    def id
+      @blog_post_id
+    end
+
+  end
+end

data/lib/weeblycloud/cloudclient/cloudclient.rb

@@ -0,0 +1,119 @@
+require "openssl"
+require "base64"
+require "json"
+require "http"
+require "weeblycloud/cloudclient/exceptions"
+
+module Weeblycloud
+  class CloudClient
+    @@api_key = nil
+    @@api_secret = nil
+
+    def initialize(api_key = nil, api_secret = nil)
+      if api_key || api_secret
+        self.configure(api_key, api_secret)
+      elsif @@api_key.nil? || @@api_secret.nil?
+        raise "No API keys provided."
+      end
+
+      @BASE_API = "https://api.weeblycloud.com/"
+    end
+
+    # Globally configure API key and secret
+    def self.configure(api_key, api_secret)
+      @@api_key = api_key
+      @@api_secret = api_secret
+    end
+
+    # Make a GET request
+    def get(endpoint, options={})
+      ops = {
+        :page_size => nil,
+        :page => nil,
+        :params => {},
+        :content => {}
+      }
+      ops.merge!(options)
+      if ops[:page_size]
+        ops[:params].merge!({"page_size" => ops[:page_size]})
+      end
+
+      if ops[:page]
+        ops[:params].merge!({"page" => options[:page]})
+      end
+
+      return call("GET", endpoint, ops[:content], ops[:params])
+    end
+
+    # Make a POST request
+    def post(endpoint, options={})
+      ops = {:params => {}, :content => {}}
+      ops.merge!(options)
+
+      return call("POST", endpoint, ops[:content], ops[:params])
+    end
+
+    # Make a PATCH request
+    def patch(endpoint, options={})
+      ops = {:params => {}, :content => {}}
+      ops.merge!(options)
+
+      return call("PATCH", endpoint, ops[:content], ops[:params])
+    end
+
+    # Make a PUT request
+    def put(endpoint, options={})
+      ops = {:params => {}, :content => {}}
+      ops.merge!(options)
+
+      return call("PUT", endpoint, ops[:content], ops[:params])
+    end
+
+    # Make a DELETE request
+    def delete(endpoint, options={})
+      ops = {:params => {}, :content => {}}
+      ops.merge!(options)
+
+      return call("DELETE", endpoint, ops[:content], ops[:params])
+    end
+
+    private
+
+    # Make an API call
+    def call(method, endpoint, content={}, params={})
+      json_data = content.to_json
+      strip_slashes(endpoint)
+      headers = {
+        "Content-Type" => "application/json",
+        "X-Cloud-Client-Type" => "ruby",
+        "X-Cloud-Client-Version" => VERSION,
+        "X-Public-Key" => @@api_key,
+        "X-Signed-Request-Hash" => sign(method, endpoint, json_data)
+      }
+      url = @BASE_API + endpoint
+      response = HTTP.headers(headers).request(method, url, :body => json_data, :params => params)
+      return WeeblyCloudResponse.new(response, url, headers, content, params)
+    end
+
+    # Signs a request and returns the HMAC hash.
+    # See https://cloud-developer.weebly.com/about-the-rest-apis.html#signing-and-authenticating-requests
+    def sign(request_type, endpoint, content)
+      request = request_type + "\n" + endpoint + "\n" + content
+      digest = OpenSSL::Digest.new("sha256")
+      mac = OpenSSL::HMAC.hexdigest(digest, @@api_secret, request)
+      base = Base64.strict_encode64(mac)
+      return base
+    end
+
+    # Remove a "/" if it is the first or last character in a string.
+    def strip_slashes(str)
+      if str.index("/") === 0
+        str = str.slice(1..-1)
+      end
+      if str.index("/") === str.length
+        str = str.slice(0..-2)
+      end
+    end
+
+  end
+end

data/lib/weeblycloud/cloudclient/exceptions.rb

@@ -0,0 +1,17 @@
+module Weeblycloud
+
+  # Raised with a response error from the API
+  class ResponseError < StandardError
+    attr_reader :code, :message
+
+    def initialize(msg = "Unknown error occured", code)
+      @code = code
+      @message = msg
+      m = "(CODE: \##{@code}) #{@msg}"
+      super(m)
+    end
+  end
+
+  # Raised with invalid pagination method invocation
+  PaginationError = Class.new(StandardError)
+end

data/lib/weeblycloud/cloudclient/weeblycloudresponse.rb

@@ -0,0 +1,141 @@
+require "HTTP"
+require "json"
+require "weeblycloud/cloudclient/exceptions"
+
+module Weeblycloud
+
+  class WeeblyCloudResponse
+    include Enumerable
+    attr_reader :json, :page_size, :max_page, :current_page, :records, :list
+
+    def initialize(response, endpoint, headers, content, params)
+      @page_size = nil
+      @max_page = nil
+      @current_page = nil
+      @records = nil
+      @is_paginated = false
+
+      # private
+      @response = response
+      @endpoint = endpoint
+      @content = content
+      @params = params
+      @headers = headers
+      @first_iter = true
+
+      refresh()
+    end
+
+    # Returns whether the results are paginated
+    def paginated?
+      @is_paginated
+    end
+
+    # Get the next page, return True on success, False on failure. If the WeeblyCloudResponse is
+    # not paginated, raise an exception.
+    def next_page()
+      if not @is_paginated
+        raise PaginationError, "Not paginated"
+      end
+
+      if @current_page >= @max_page
+        return False
+      end
+
+      next_page = @params["page"].nil? ? 2 : @params["page"] + 1
+
+      @params.merge!({"page"=>next_page})
+      @response = HTTP.headers(@headers).get(@endpoint, :body => "{}", :params => @params)
+      refresh()
+    end
+
+    # Iterate over all pages. Accepts a block.
+    def each(&block)
+      if @is_paginated
+        # loop over all pages
+        while @current_page < @max_page
+          @list.each{|item| yield(item) }
+          if @first_iter
+            @first_iter = false
+          else
+            next_page()
+          end
+        end
+      else
+        # If it isn't paginated just do it once
+        @list.each{ |item| yield(item) }
+      end
+    end
+
+    # Returns the current page as a JSON string
+    def to_s()
+      @json.to_json
+    end
+
+    # Returns the current page as a hash
+    def to_hash()
+      @json
+    end
+
+    private
+
+    # Refreshes the internal parameters based on the current value of @request.
+    def refresh()
+      @status_code = @response.code
+
+      # Handle errors. Sometimes there may not be a response body (which is why ValueError)
+      #   must be caught.
+      begin
+        if !([200,204].include? @status_code) || @response.parse().include?("error")
+          error = @response.parse()
+          raise ResponseError.new(error["error"]["message"], error["error"]["code"])
+        end
+      rescue NoMethodError, HTTP::Error
+        # Sometimes DELETE returns nothing. When this is the case, it will have a status code 204
+        raise ResponseError.new(code=@status_code) unless @status_code == 204
+      end
+
+      # Get information on paging if response is paginated
+      headers = @response.headers
+      if headers["X-Resultset-Total"] && headers["X-Resultset-Total"].to_i > headers["X-Resultset-Limit"].to_i
+        @is_paginated = true
+        @records = headers["X-Resultset-Total"].to_i
+        @page_size = headers["X-Resultset-Limit"].to_i
+        @current_page = headers["X-Resultset-Page"].to_i
+        @max_page = (@records.to_f / @page_size.to_i).ceil
+      end
+
+      # Save the content of the request
+      begin
+        @json = @response.parse()
+
+        # Parse the result so it can be paged over.
+        if @is_paginated
+          if @json.is_a?(Hash) == true
+            @list = @json.first[1]
+          else
+            @list = @json
+          end
+        else
+          if @json.kind_of?(Array)
+            @list = @json
+          elsif @json.values[0].kind_of?(Array)
+            @list = @json.values[0]
+          else
+            # I think this accounts for plan
+            @list = @json.values
+          end
+        end
+
+      rescue NoMethodError, HTTP::Error
+        # Sometimes DELETE returns nothing. When this is the case, it will have a status code 204
+        if @status_code == 204
+          @json = {"success" => true}
+        else
+          raise ResponseError.new(code = @status_code)
+        end
+      end
+    end
+
+  end
+end

data/lib/weeblycloud/cloudresource.rb

@@ -0,0 +1,62 @@
+require 'weeblycloud/cloudclient/cloudclient'
+require 'json'
+
+module Weeblycloud
+
+  # A base resource that all other resources inherit from.
+  class CloudResource
+    attr_reader :properties
+
+    def initialize(data = nil)
+      @client = CloudClient.new
+      @properties = {}
+      @changed = {}
+
+      # If data isn't provided, make an API call to get it
+      if data
+        @properties = data
+        @got = true
+      else
+        get()
+        @got = true
+      end
+    end
+
+    # Get a property. Returns nil if the property does not exist.
+    def get_property(prop)
+      begin
+        return @properties.fetch(prop)
+      raise KeyError
+        if @got
+          return nil
+        else
+          get()
+          @got = true
+          return get_property(prop)
+        end
+      end
+    end
+
+    # Get a property. Returns nil if the property does not exist.
+    def [](prop)
+      get_property(prop)
+    end
+
+    # Returns the properties as a json string
+    def to_s
+      @properties.to_json
+    end
+
+    # Returns the ID for the resource object
+    def id
+      raise "Method not implemented."
+    end
+
+    # Gets the resources with an API call
+    def get
+      @response = @client.get(@endpoint)
+      @properties = @response.json
+    end
+
+  end
+end

data/lib/weeblycloud/deleteable.rb

@@ -0,0 +1,13 @@
+module Weeblycloud
+
+  # CloudResource objects may use this module if they can be deleted
+  module Deleteable
+
+    # Delete the resource
+    def delete
+      response = @client.delete(@endpoint)
+      return response.json["success"]
+    end
+
+  end
+end

data/lib/weeblycloud/form.rb

@@ -0,0 +1,39 @@
+require "weeblycloud/cloudresource"
+
+require "weeblycloud/formentry"
+
+module Weeblycloud
+
+  # Represents a Form resource.
+  # https://cloud-developer.weebly.com/form.html
+  class Form < CloudResource
+
+    def initialize(user_id, site_id, form_id, data = nil)
+      @user_id = user_id.to_i
+      @site_id = site_id.to_i
+      @form_id = form_id.to_i
+
+      @endpoint = "user/#{@user_id}/site/#{@site_id}/form/#{@form_id}"
+
+      super(data)
+    end
+
+    # Returns the form_id
+    def id
+      @form_id
+    end
+
+    # Returns a list of FormEntry resources for a given form subject to filters.
+    def list_form_entries(filters={})
+      result = @client.get(@endpoint + "/entry", :params=>filters)
+      return result.map { |i| FormEntry.new(@user_id, @site_id, i["form_entry_id"], i) }
+    end
+
+    # Return the FormEntry with the given id.
+    def get_form_entry(form_entry_id)
+      return FormEntry.new(@user_id, @site_id, @form_id, @form_entry_id)
+    end
+
+  end
+
+end

data/lib/weeblycloud/formentry.rb

@@ -0,0 +1,26 @@
+require "weeblycloud/cloudresource"
+
+module Weeblycloud
+
+  # Represents a FormEntry resource.
+  # https://cloud-developer.weebly.com/form-entry.html
+  class FormEntry < CloudResource
+
+    def initialize(user_id, site_id, form_id, form_entry_id, data = nil)
+      @user_id = user_id.to_i
+      @site_id = site_id.to_i
+      @form_id = form_id.to_i
+      @form_entry_id = form_entry_id.to_i
+      @endpoint = "user/#{@user_id}/site/#{@site_id}/form/#{@form_id}/entry/#{@form_entry_id}"
+
+      super(data)
+    end
+
+    # Returns the form_entry_id
+    def id
+      @form_entry_id
+    end
+
+  end
+
+end