screenbeacon 0.1.0

data/lib/screenbeacon/alert.rb

@@ -0,0 +1,32 @@
+module Screenbeacon
+  class Alert < APIResource
+    include Screenbeacon::APIOperations::List
+
+    def resolve(opts={})
+      response, opts = request(:patch, resolve_url, {}, opts)
+      refresh_from(response, opts)
+    end
+
+    # Resolve all alerts on account
+    def self.resolve_all(opts={})
+      response, opts = request(:post, resolve_all_url, {}, opts)
+      refresh_from(response, opts)
+    end
+
+    def self.resolve_all(filters={}, opts={})
+      response, opts = request(:post, resolve_all_url, filters, opts)
+      Util.convert_to_screenbeacon_object(response, opts)
+    end
+
+    private
+
+    def resolve_url
+      url + '/resolve'
+    end
+
+    def self.resolve_all_url
+      url + '/resolve'
+    end
+
+  end
+end

data/lib/screenbeacon/api_operations/create.rb

@@ -0,0 +1,16 @@
+module Screenbeacon
+  module APIOperations
+    module Create
+      module ClassMethods
+        def create(params={}, opts={})
+          response, opts = request(:post, url, params, opts)
+          Util.convert_to_screenbeacon_object(response, opts)
+        end
+      end
+
+      def self.included(base)
+        base.extend(ClassMethods)
+      end
+    end
+  end
+end

data/lib/screenbeacon/api_operations/delete.rb

@@ -0,0 +1,11 @@
+module Screenbeacon
+  module APIOperations
+    module Delete
+      def delete(params={}, opts={})
+        opts = Util.normalize_opts(opts)
+        response, opts = request(:delete, url, params, opts)
+        refresh_from(response, opts)
+      end
+    end
+  end
+end

data/lib/screenbeacon/api_operations/list.rb

@@ -0,0 +1,17 @@
+module Screenbeacon
+  module APIOperations
+    module List
+      module ClassMethods
+        def all(filters={}, opts={})
+          opts = Util.normalize_opts(opts)
+          response, opts = request(:get, url, filters, opts)
+          Util.convert_to_screenbeacon_object(response, opts)
+        end
+      end
+
+      def self.included(base)
+        base.extend(ClassMethods)
+      end
+    end
+  end
+end

data/lib/screenbeacon/api_operations/request.rb

@@ -0,0 +1,42 @@
+module Screenbeacon
+  module APIOperations
+    module Request
+      module ClassMethods
+        OPTS_KEYS_TO_PERSIST = Set[:api_id, :api_token, :api_base, :screenbeacon_version]
+
+        def request(method, url, params={}, opts={})
+          opts = Util.normalize_opts(opts)
+
+          headers = opts.clone
+          api_id = headers.delete(:api_id)
+          api_token = headers.delete(:api_token)
+          api_base = headers.delete(:api_base)
+          # Assume all remaining opts must be headers
+
+          response, opts[:api_id], opts[:api_token] = Screenbeacon.request(method, url, api_id, api_token, params, headers, api_base)
+
+          # Hash#select returns an array before 1.9
+          opts_to_persist = {}
+          opts.each do |k, v|
+            if OPTS_KEYS_TO_PERSIST.include?(k)
+              opts_to_persist[k] = v
+            end
+          end
+
+          [response, opts_to_persist]
+        end
+      end
+
+      def self.included(base)
+        base.extend(ClassMethods)
+      end
+
+      protected
+
+      def request(method, url, params={}, opts={})
+        opts = @opts.merge(Util.normalize_opts(opts))
+        self.class.request(method, url, params, opts)
+      end
+    end
+  end
+end

data/lib/screenbeacon/api_operations/update.rb

@@ -0,0 +1,17 @@
+module Screenbeacon
+  module APIOperations
+    module Update
+      def save(params={})
+        values = self.class.serialize_params(self).merge(params)
+
+        if values.length > 0
+          values.delete(:id)
+
+          response, opts = request(:put, url, values)
+          refresh_from(response, opts)
+        end
+        self
+      end
+    end
+  end
+end

data/lib/screenbeacon/api_resource.rb

@@ -0,0 +1,35 @@
+module Screenbeacon
+  class APIResource < ScreenbeaconObject
+    include Screenbeacon::APIOperations::Request
+
+    def self.class_name
+      self.name.split('::')[-1]
+    end
+
+    def self.url
+      if self == APIResource
+        raise NotImplementedError.new('APIResource is an abstract class.  You should perform actions on its subclasses (Project, Test, etc.)')
+      end
+      "/#{CGI.escape(class_name.downcase)}s"
+    end
+
+    def url
+      unless id = self['id']
+        raise InvalidRequestError.new("Could not determine which URL to request: #{self.class} instance has invalid ID: #{id.inspect}", 'id')
+      end
+      "#{self.class.url}/#{CGI.escape(id.to_s)}"
+    end
+
+    def refresh
+      response, opts = request(:get, url, @retrieve_params)
+      refresh_from(response, opts)
+    end
+
+    def self.retrieve(id, opts={})
+      opts = Util.normalize_opts(opts)
+      instance = self.new(id, opts)
+      instance.refresh
+      instance
+    end
+  end
+end

data/lib/screenbeacon/errors/api_connection_error.rb

@@ -0,0 +1,4 @@
+module Screenbeacon
+  class APIConnectionError < ScreenbeaconError
+  end
+end

data/lib/screenbeacon/errors/api_error.rb

@@ -0,0 +1,4 @@
+module Screenbeacon
+  class APIError < ScreenbeaconError
+  end
+end

data/lib/screenbeacon/errors/authentication_error.rb

@@ -0,0 +1,4 @@
+module Screenbeacon
+  class AuthenticationError < ScreenbeaconError
+  end
+end

data/lib/screenbeacon/errors/invalid_request_error.rb

@@ -0,0 +1,10 @@
+module Screenbeacon
+  class InvalidRequestError < ScreenbeaconError
+    attr_accessor :param
+
+    def initialize(message, param, http_status=nil, http_body=nil, json_body=nil)
+      super(message, http_status, http_body, json_body)
+      @param = param
+    end
+  end
+end

data/lib/screenbeacon/errors/screenbeacon_error.rb

@@ -0,0 +1,20 @@
+module Screenbeacon
+  class ScreenbeaconError < StandardError
+    attr_reader :message
+    attr_reader :http_status
+    attr_reader :http_body
+    attr_reader :json_body
+
+    def initialize(message=nil, http_status=nil, http_body=nil, json_body=nil)
+      @message = message
+      @http_status = http_status
+      @http_body = http_body
+      @json_body = json_body
+    end
+
+    def to_s
+      status_string = @http_status.nil? ? "" : "(Status #{@http_status}) "
+      "#{status_string}#{@message}"
+    end
+  end
+end

data/lib/screenbeacon/project.rb

@@ -0,0 +1,13 @@
+module Screenbeacon
+  class Project < APIResource
+    include Screenbeacon::APIOperations::Create
+    include Screenbeacon::APIOperations::Update
+    include Screenbeacon::APIOperations::Delete
+    include Screenbeacon::APIOperations::List
+
+
+    def alerts
+      Alert.all({ :project_id => id }, @opts)
+    end
+  end
+end

data/lib/screenbeacon/screenbeacon_object.rb

@@ -0,0 +1,263 @@
+module Screenbeacon
+  class ScreenbeaconObject
+    include Enumerable
+
+    @@permanent_attributes = Set.new([:id])
+
+    # The default :id method is deprecated and isn't useful to us
+    if method_defined?(:id)
+      undef :id
+    end
+
+    def initialize(id=nil, opts={})
+      # parameter overloading!
+      if id.kind_of?(Hash)
+        @retrieve_params = id.dup
+        @retrieve_params.delete(:id)
+        id = id[:id]
+      else
+        @retrieve_params = {}
+      end
+
+      @opts = opts
+      @values = {}
+      # This really belongs in APIResource, but not putting it there allows us
+      # to have a unified inspect method
+      @unsaved_values = Set.new
+      @transient_values = Set.new
+      @values[:id] = id if id
+    end
+
+    def self.construct_from(values, opts={})
+      self.new(values[:id]).refresh_from(values, opts)
+    end
+
+    def to_s(*args)
+      JSON.pretty_generate(@values)
+    end
+
+    def inspect
+      id_string = (self.respond_to?(:id) && !self.id.nil?) ? " id=#{self.id}" : ""
+      "#<#{self.class}:0x#{self.object_id.to_s(16)}#{id_string}> JSON: " + JSON.pretty_generate(@values)
+    end
+
+    def refresh_from(values, opts, partial=false)
+      @opts = opts
+      @original_values = Marshal.load(Marshal.dump(values)) # deep copy
+      removed = partial ? Set.new : Set.new(@values.keys - values.keys)
+      added = Set.new(values.keys - @values.keys)
+      # Wipe old state before setting new.  This is useful for e.g. updating a
+      # customer, where there is no persistent card parameter.  Mark those values
+      # which don't persist as transient
+
+      instance_eval do
+        remove_accessors(removed)
+        add_accessors(added)
+      end
+      removed.each do |k|
+        @values.delete(k)
+        @transient_values.add(k)
+        @unsaved_values.delete(k)
+      end
+      values.each do |k, v|
+        @values[k] = Util.convert_to_screenbeacon_object(v, @opts)
+        @transient_values.delete(k)
+        @unsaved_values.delete(k)
+      end
+
+      return self
+    end
+
+    def [](k)
+      @values[k.to_sym]
+    end
+
+    def []=(k, v)
+      send(:"#{k}=", v)
+    end
+
+    def keys
+      @values.keys
+    end
+
+    def values
+      @values.values
+    end
+
+    def to_json(*a)
+      JSON.generate(@values)
+    end
+
+    def as_json(*a)
+      @values.as_json(*a)
+    end
+
+    def to_hash
+      @values.inject({}) do |acc, (key, value)|
+        acc[key] = value.respond_to?(:to_hash) ? value.to_hash : value
+        acc
+      end
+    end
+
+    def each(&blk)
+      @values.each(&blk)
+    end
+
+    def _dump(level)
+      Marshal.dump([@values, @opts])
+    end
+
+    def self._load(args)
+      values, opts = Marshal.load(args)
+      construct_from(values, opts)
+    end
+
+    if RUBY_VERSION < '1.9.2'
+      def respond_to?(symbol)
+        @values.has_key?(symbol) || super
+      end
+    end
+
+    def serialize_nested_object(key)
+      new_value = @values[key]
+      if new_value.is_a?(APIResource)
+        return {}
+      end
+
+      if @unsaved_values.include?(key)
+        # the object has been reassigned
+        # e.g. as object.key = {foo => bar}
+        update = new_value
+        new_keys = update.keys.map(&:to_sym)
+
+        # remove keys at the server, but not known locally
+        if @original_values.include?(key)
+          keys_to_unset = @original_values[key].keys - new_keys
+          keys_to_unset.each {|key| update[key] = ''}
+        end
+
+        update
+      else
+        # can be serialized normally
+        self.class.serialize_params(new_value)
+      end
+    end
+
+    def self.serialize_params(obj, original_value=nil)
+      case obj
+      when nil
+        ''
+      when ScreenbeaconObject
+        unsaved_keys = obj.instance_variable_get(:@unsaved_values)
+        obj_values = obj.instance_variable_get(:@values)
+        update_hash = {}
+
+        unsaved_keys.each do |k|
+          update_hash[k] = serialize_params(obj_values[k])
+        end
+
+        obj_values.each do |k, v|
+          if v.is_a?(ScreenbeaconObject) || v.is_a?(Hash)
+            update_hash[k] = obj.serialize_nested_object(k)
+          elsif v.is_a?(Array)
+            original_value = obj.instance_variable_get(:@original_values)[k]
+            if original_value && original_value.length > v.length
+              # url params provide no mechanism for deleting an item in an array,
+              # just overwriting the whole array or adding new items. So let's not
+              # allow deleting without a full overwrite until we have a solution.
+              raise ArgumentError.new(
+                "You cannot delete an item from an array, you must instead set a new array"
+              )
+            end
+            update_hash[k] = serialize_params(v, original_value)
+          end
+        end
+
+        update_hash
+      when Array
+        update_hash = {}
+        obj.each_with_index do |value, index|
+          update = serialize_params(value)
+          if update != {} && (!original_value || update != original_value[index])
+            update_hash[index] = update
+          end
+        end
+
+        if update_hash == {}
+          nil
+        else
+          update_hash
+        end
+      else
+        obj
+      end
+    end
+
+    protected
+
+    def metaclass
+      class << self; self; end
+    end
+
+    def remove_accessors(keys)
+      metaclass.instance_eval do
+        keys.each do |k|
+          next if @@permanent_attributes.include?(k)
+          k_eq = :"#{k}="
+          remove_method(k) if method_defined?(k)
+          remove_method(k_eq) if method_defined?(k_eq)
+        end
+      end
+    end
+
+    def add_accessors(keys)
+      metaclass.instance_eval do
+        keys.each do |k|
+          next if @@permanent_attributes.include?(k)
+          k_eq = :"#{k}="
+          define_method(k) { @values[k] }
+          define_method(k_eq) do |v|
+            if v == ""
+              raise ArgumentError.new(
+                "You cannot set #{k} to an empty string." \
+                "We interpret empty strings as nil in requests." \
+                "You may set #{self}.#{k} = nil to delete the property.")
+            end
+            @values[k] = v
+            @unsaved_values.add(k)
+          end
+        end
+      end
+    end
+
+    def method_missing(name, *args)
+      # TODO: only allow setting in updateable classes.
+      if name.to_s.end_with?('=')
+        attr = name.to_s[0...-1].to_sym
+        add_accessors([attr])
+        begin
+          mth = method(name)
+        rescue NameError
+          raise NoMethodError.new("Cannot set #{attr} on this object. HINT: you can't set: #{@@permanent_attributes.to_a.join(', ')}")
+        end
+        return mth.call(args[0])
+      else
+        return @values[name] if @values.has_key?(name)
+      end
+
+      begin
+        super
+      rescue NoMethodError => e
+        if @transient_values.include?(name)
+          raise NoMethodError.new(e.message + ".  HINT: The '#{name}' attribute was set in the past, however.  It was then wiped when refreshing the object with the result returned by Screenbeacon's API, probably as a result of a save().  The attributes currently available on this object are: #{@values.keys.join(', ')}")
+        else
+          raise
+        end
+      end
+    end
+
+    def respond_to_missing?(symbol, include_private = false)
+      @values && @values.has_key?(symbol) || super
+    end
+  end
+end

data/lib/screenbeacon/test.rb

@@ -0,0 +1,8 @@
+module Screenbeacon
+  class Test < APIResource
+    include Screenbeacon::APIOperations::Create
+    include Screenbeacon::APIOperations::Update
+    include Screenbeacon::APIOperations::Delete
+    include Screenbeacon::APIOperations::List
+  end
+end

data/lib/screenbeacon/util.rb

@@ -0,0 +1,130 @@
+module Screenbeacon
+  module Util
+    def self.objects_to_ids(h)
+      case h
+      when APIResource
+        h.id
+      when Hash
+        res = {}
+        h.each { |k, v| res[k] = objects_to_ids(v) unless v.nil? }
+        res
+      when Array
+        h.map { |v| objects_to_ids(v) }
+      else
+        h
+      end
+    end
+
+    def self.object_classes
+      @object_classes ||= {
+        # data structures
+        'project' => Project,
+        'test' => Test,
+        'alert' => Alert
+      }
+    end
+
+    def self.convert_to_screenbeacon_object(resp, opts)
+      case resp
+      when Array
+        resp.map { |i| convert_to_screenbeacon_object(i, opts) }
+      when Hash
+        # Try converting to a known object class.  If none available, fall back to generic ScreenbeaconObject
+        object_classes.fetch(resp[:object], ScreenbeaconObject).construct_from(resp, opts)
+      else
+        resp
+      end
+    end
+
+    def self.file_readable(file)
+      # This is nominally equivalent to File.readable?, but that can
+      # report incorrect results on some more oddball filesystems
+      # (such as AFS)
+      begin
+        File.open(file) { |f| }
+      rescue
+        false
+      else
+        true
+      end
+    end
+
+    def self.symbolize_names(object)
+      case object
+      when Hash
+        new_hash = {}
+        object.each do |key, value|
+          key = (key.to_sym rescue key) || key
+          new_hash[key] = symbolize_names(value)
+        end
+        new_hash
+      when Array
+        object.map { |value| symbolize_names(value) }
+      else
+        object
+      end
+    end
+
+    def self.url_encode(key)
+      URI.escape(key.to_s, Regexp.new("[^#{URI::PATTERN::UNRESERVED}]"))
+    end
+
+    def self.flatten_params(params, parent_key=nil)
+      result = []
+      params.each do |key, value|
+        calculated_key = parent_key ? "#{parent_key}[#{url_encode(key)}]" : url_encode(key)
+        if value.is_a?(Hash)
+          result += flatten_params(value, calculated_key)
+        elsif value.is_a?(Array)
+          result += flatten_params_array(value, calculated_key)
+        else
+          result << [calculated_key, value]
+        end
+      end
+      result
+    end
+
+    def self.flatten_params_array(value, calculated_key)
+      result = []
+      value.each do |elem|
+        if elem.is_a?(Hash)
+          result += flatten_params(elem, calculated_key)
+        elsif elem.is_a?(Array)
+          result += flatten_params_array(elem, calculated_key)
+        else
+          result << ["#{calculated_key}[]", elem]
+        end
+      end
+      result
+    end
+
+    # The secondary opts argument can either be a string or hash
+    # Turn this value into an api_key and a set of headers
+    def self.normalize_opts(opts)
+      case opts
+      when String
+        {:api_key => opts}
+      when Hash
+        check_api_id!(opts.fetch(:api_id)) if opts.has_key?(:api_id)
+        check_api_token!(opts.fetch(:api_token)) if opts.has_key?(:api_token)
+        opts.clone
+      else
+        raise TypeError.new('normalize_opts expects a string or a hash')
+      end
+    end
+
+    def self.check_string_argument!(key)
+      raise TypeError.new("argument must be a string") unless key.is_a?(String)
+      key
+    end
+
+    def self.check_api_id!(id)
+      raise TypeError.new("api_id must be a string") unless id.is_a?(String)
+      id
+    end
+    def self.check_api_token!(token)
+      raise TypeError.new("api_token must be a string") unless token.is_a?(String)
+      token
+    end
+  end
+end

data/lib/screenbeacon/version.rb

@@ -0,0 +1,3 @@
+module Screenbeacon
+  VERSION = '0.1.0'
+end