rainforest 1.0.7 → 2.0.0

data/lib/rainforest/apibits/params_builder.rb

@@ -0,0 +1,27 @@
+module Rainforest
+  module ParamsBuilder
+
+    def self.clean(params)
+      Util.symbolize_keys(params || {})
+    end
+
+    # Clean the params, and the hash to_merge, and then merge them.
+    # This ensures that we dont get something like { "id" => 123, :id => 321 }.
+    def self.merge(*args)
+      ret = {}
+      args.each do |arg|
+        ret = ret.merge(clean(arg))
+      end
+      ret
+    end
+
+    def self.build(params, api_key=nil, auth_key=nil)
+      default_params.merge(clean(params))
+    end
+
+    def self.default_params
+      params = {}
+    end
+
+  end
+end

data/lib/rainforest/apibits/path_builder.rb

@@ -0,0 +1,38 @@
+module Rainforest
+  module PathBuilder
+
+    # Take a path like:
+    #   ":path/:id/dogs/:dog_id"
+    # and convert it to:
+    #   "#{object.path}/#{object.id}/dogs/#{params[:id]}" => "/objects/1/dogs/2"
+    #
+    # Path priority is:
+    #   1. Object - this will be a class or an instance of a class.
+    #   2. Params - this is a hash of key values. All keys *must* be symbolized.
+    def self.build(path, object, params)
+      ret = path.dup
+      if ret.include?(":")
+        matches = ret.scan(/:([^\/]*)/).flatten.map(&:to_sym)
+        missing = Set.new(matches)
+
+        matches.each do |match|
+          value = determine_value(match, object, params)
+          missing.delete(match) unless value.nil?
+          ret.sub!(match.inspect, "#{value}")
+        end
+
+        if missing.any?
+          raise ArgumentError.new("Could not determine the full URL. The following values of the path are missing: #{missing.to_a.join(', ')}. Try setting them in your params.")
+        end
+      end
+      ret
+    end
+
+    def self.determine_value(match, object, params)
+      value = object.send(match) if object && object.respond_to?(match)
+      value ||= params[match] if params && params.has_key?(match)
+      value
+    end
+
+  end
+end

data/lib/rainforest/apibits/requester.rb

@@ -0,0 +1,104 @@
+module Rainforest
+  module Requester
+
+    def self.request(method, url, params={}, headers={})
+      method = method.to_sym
+      url, params = prepare_params(method, url, params, headers)
+      request_opts = {
+        :method => method,
+        :url => url,
+        :headers => headers,
+        :payload => params,
+
+        :verify_ssl => false,
+        :open_timeout => 30,
+        :timeout => 60
+      }
+
+      execute_request(request_opts)
+    end
+
+    def self.execute_request(opts)
+      RestClient::Request.execute(opts)
+    end
+
+    def self.get(url, params, headers)
+      self.request(:get, url, params, headers)
+    end
+
+    def self.delete(url, params, headers)
+      self.request(:delete, url, params, headers)
+    end
+
+    def self.put(url, params, headers)
+      self.request(:put, url, params, headers)
+    end
+
+    def self.post(url, params, headers)
+      self.request(:post, url, params, headers)
+    end
+
+    def self.prepare_params(method, url, params={}, headers={})
+      if [:get, :head, :delete].include?(method)
+        unless params.empty?
+          url += URI.parse(url).query ? '&' : '?' + query_string(params)
+        end
+        params = nil
+      else
+        if headers["Content-Type"] == "application/json" || headers[:"Content-Type"] == "application/json"
+          params = JSON.generate(params)
+        else
+          headers["Content-Type"] = "application/x-www-form-urlencoded"
+          if !RestClient::Payload.has_file?(params)
+            params = query_string(params)
+          end
+        end
+      end
+      [url, params]
+    end
+
+    def self.query_string(params)
+      params ||= {}
+      if params.any?
+        query_array(params).join('&')
+      else
+        ""
+      end
+    end
+
+    # Three major use cases (and nesting of them needs to be supported):
+    #   { :a => { :b => "bvalue" } }  => ["a[b]=bvalue"]
+    #   { :a => [1, 2] }           => ["a[]=1", "a[]=2"]
+    #   { :a => "value" }          => ["a=value"]
+    def self.query_array(params, key_prefix=nil)
+      ret = []
+      params.each do |key, value|
+        if params.is_a?(Array)
+          value = key
+          key = ''
+        end
+        key_suffix = escape(key)
+        full_key = key_prefix ? "#{key_prefix}[#{key_suffix}]" : key_suffix
+
+        if value.is_a?(Hash) || value.is_a?(Array)
+          # Handles the following cases:
+          #   { :a => { :b => "bvalue" } }  => ["a[b]=bvalue"]
+          #   { :a => [1, 2] }           => ["a[]=1", "a[]=2"]
+          ret += query_array(value, full_key)
+        elsif value.is_a?(ApiObject)
+          ret += query_array(value.json, full_key)
+        else
+          # Handles the base case with just key and value:
+          #   { :a => "value" } => ["a=value"]
+          ret << "#{full_key}=#{escape(value)}"
+        end
+      end
+      ret
+    end
+
+    def self.escape(val)
+      URI.escape(val.to_s, Regexp.new("[^#{URI::PATTERN::UNRESERVED}]"))
+    end
+
+  end
+end

data/lib/rainforest/apibits/util.rb

@@ -0,0 +1,51 @@
+module Rainforest
+  module Util
+
+    def self.symbolize_keys(obj)
+      if obj.is_a?(Hash)
+        ret = {}
+        obj.each do |key, value|
+          ret[(key.to_sym rescue key) || key] = symbolize_keys(value)
+        end
+        return ret
+      elsif obj.is_a?(Array)
+        return obj.map{ |value| symbolize_keys(value) }
+      else
+        return obj
+      end
+    end
+
+    def self.sorta_deep_clone(json)
+      if json.is_a?(Hash)
+        ret = {}
+        json.each do |k, v|
+          ret[k] = sorta_deep_clone(v)
+        end
+        ret
+      elsif json.is_a?(Array)
+        json.map{ |j| sorta_deep_clone(j) }
+      else
+        begin
+          json.dup
+        rescue
+          json
+        end
+      end
+    end
+
+    def self.constantize(str, prefix=false)
+      str = str.to_s
+      begin
+        str.split('::').reduce(Rainforest, :const_get)
+      rescue NameError => e
+        if prefix
+          raise e
+        else
+          p = "#{self.name}".split("::").first
+          constantize("#{p}::#{str}", true)
+        end
+      end
+    end
+
+  end
+end

data/lib/rainforest/clients/default_client.rb

@@ -0,0 +1,59 @@
+module Rainforest
+  class DefaultClient < ApiClient
+
+    def initialize(api_key)
+      self.refresh_from(api_key)
+    end
+
+    def refresh_from(api_key)
+      headers = {
+        :Accept => "application/json",
+        :"Content-Type" => "application/x-www-form-urlencoded",
+        :CLIENT_TOKEN => api_key,
+      }
+      params = {}
+      super(headers, params)
+    end
+
+    def client_stats
+      @client_stats ||= ClientStatsEndpoint.new(self)
+    end
+
+    def environments
+      @environments ||= EnvironmentsEndpoint.new(self)
+    end
+
+    def generators
+      @generators ||= GeneratorsEndpoint.new(self)
+    end
+
+    def integrations
+      @integrations ||= IntegrationsEndpoint.new(self)
+    end
+
+    def runs
+      @runs ||= RunsEndpoint.new(self)
+    end
+
+    def schedules
+      @schedules ||= SchedulesEndpoint.new(self)
+    end
+
+    def site_environments
+      @site_environments ||= SiteEnvironmentsEndpoint.new(self)
+    end
+
+    def sites
+      @sites ||= SitesEndpoint.new(self)
+    end
+
+    def tests
+      @tests ||= TestsEndpoint.new(self)
+    end
+
+    def users
+      @users ||= UsersEndpoint.new(self)
+    end
+
+  end
+end

data/lib/rainforest/endpoints/client_stats_endpoint.rb

@@ -0,0 +1,11 @@
+module Rainforest
+  class ClientStatsEndpoint < ApiEndpoint
+
+    def retrieve(params={}, headers={})
+      method = ApiMethod.new(:get, "/clients/stats", params, headers, @parent)
+      json = @client.execute(method)
+      ClientStats.new(json, method)
+    end
+
+  end
+end

data/lib/rainforest/endpoints/environment_runs_endpoint.rb

@@ -0,0 +1,11 @@
+module Rainforest
+  class EnvironmentRunsEndpoint < ApiEndpoint
+
+    def all(params={}, headers={})
+      method = ApiMethod.new(:get, "/environments/:id/runs", params, headers, @parent)
+      json = @client.execute(method)
+      ApiList.new(:Run, json, method)
+    end
+
+  end
+end

data/lib/rainforest/endpoints/environments_endpoint.rb

@@ -0,0 +1,48 @@
+module Rainforest
+  class EnvironmentsEndpoint < ApiEndpoint
+
+    def new(id)
+      Environment.new({:id => id}, nil, @client)
+    end
+
+    def all(params={}, headers={})
+      method = ApiMethod.new(:get, "/environments", params, headers, @parent)
+      json = @client.execute(method)
+      ApiList.new(:Environment, json, method)
+    end
+
+    def retrieve(environment_id, params={}, headers={})
+      params = ParamsBuilder.merge({
+        :environment_id => environment_id,
+      }, params)
+      method = ApiMethod.new(:get, "/environments/:environment_id", params, headers, @parent)
+      json = @client.execute(method)
+      Environment.new(json, method)
+    end
+
+    def delete(environment_id, params={}, headers={})
+      params = ParamsBuilder.merge({
+        :environment_id => environment_id,
+      }, params)
+      method = ApiMethod.new(:delete, "/environments/:environment_id", params, headers, @parent)
+      json = @client.execute(method)
+      json
+    end
+
+    def update(environment_id, params={}, headers={})
+      params = ParamsBuilder.merge({
+        :environment_id => environment_id,
+      }, params)
+      method = ApiMethod.new(:put, "/environments/:environment_id", params, headers, @parent)
+      json = @client.execute(method)
+      Environment.new(json, method)
+    end
+
+    def create(params={}, headers={})
+      method = ApiMethod.new(:post, "/environments", params, headers, @parent)
+      json = @client.execute(method)
+      Environment.new(json, method)
+    end
+
+  end
+end

data/lib/rainforest/endpoints/generator_rows_endpoint.rb

@@ -0,0 +1,17 @@
+module Rainforest
+  class GeneratorRowsEndpoint < ApiEndpoint
+
+    def all(params={}, headers={})
+      method = ApiMethod.new(:get, "/generators/:id/rows", params, headers, @parent)
+      json = @client.execute(method)
+      json
+    end
+
+    def create(params={}, headers={})
+      method = ApiMethod.new(:post, "/generators/:id/rows", params, headers, @parent)
+      json = @client.execute(method)
+      json
+    end
+
+  end
+end

data/lib/rainforest/endpoints/generators_endpoint.rb

@@ -0,0 +1,48 @@
+module Rainforest
+  class GeneratorsEndpoint < ApiEndpoint
+
+    def new(id)
+      Generator.new({:id => id}, nil, @client)
+    end
+
+    def all(params={}, headers={})
+      method = ApiMethod.new(:get, "/generators", params, headers, @parent)
+      json = @client.execute(method)
+      ApiList.new(:Generator, json, method)
+    end
+
+    def retrieve(generator_id, params={}, headers={})
+      params = ParamsBuilder.merge({
+        :generator_id => generator_id,
+      }, params)
+      method = ApiMethod.new(:get, "/generators/:generator_id", params, headers, @parent)
+      json = @client.execute(method)
+      Generator.new(json, method)
+    end
+
+    def delete(generator_id, params={}, headers={})
+      params = ParamsBuilder.merge({
+        :generator_id => generator_id,
+      }, params)
+      method = ApiMethod.new(:delete, "/generators/:generator_id", params, headers, @parent)
+      json = @client.execute(method)
+      Generator.new(json, method)
+    end
+
+    def update(generator_id, params={}, headers={})
+      params = ParamsBuilder.merge({
+        :generator_id => generator_id,
+      }, params)
+      method = ApiMethod.new(:put, "/generators/:generator_id", params, headers, @parent)
+      json = @client.execute(method)
+      Generator.new(json, method)
+    end
+
+    def create(params={}, headers={})
+      method = ApiMethod.new(:post, "/generators", params, headers, @parent)
+      json = @client.execute(method)
+      Generator.new(json, method)
+    end
+
+  end
+end

data/lib/rainforest/endpoints/integrations_endpoint.rb

@@ -0,0 +1,33 @@
+module Rainforest
+  class IntegrationsEndpoint < ApiEndpoint
+
+    def new(id)
+      Integration.new({:id => id}, nil, @client)
+    end
+
+    def all(params={}, headers={})
+      method = ApiMethod.new(:get, "/integrations", params, headers, @parent)
+      json = @client.execute(method)
+      ApiList.new(:Integration, json, method)
+    end
+
+    def retrieve(integration_id, params={}, headers={})
+      params = ParamsBuilder.merge({
+        :integration_id => integration_id,
+      }, params)
+      method = ApiMethod.new(:get, "/integrations/:integration_id", params, headers, @parent)
+      json = @client.execute(method)
+      Integration.new(json, method)
+    end
+
+    def update(integration_id, params={}, headers={})
+      params = ParamsBuilder.merge({
+        :integration_id => integration_id,
+      }, params)
+      method = ApiMethod.new(:put, "/integrations/:integration_id", params, headers, @parent)
+      json = @client.execute(method)
+      Integration.new(json, method)
+    end
+
+  end
+end