neuron-client 0.1.0 → 0.2.0

data/README.md

@@ -5,31 +5,57 @@ Neuron Client Gem
 Setup
 =====
 
-    Neuron::Client::API.configure do |config|
-      config.admin_url = "https://example.com"
-      config.admin_key = "secret"
-    end
+Connect to the admin server for read/write access to exposed models:
 
+  Neuron::Client::API.default_api.configure do |config|
+    config.connection_type = :admin
+    config.admin_url = "https://example.com"
+    config.admin_key = "secret"
+  end
+
+  Short form to copy and paste into console:
+
+  Neuron::Client::API.default_api.configure {|config| config.connection_type = :admin; config.admin_url = 'http://localhost:3000'; config.admin_key = 'secret'}
+
+
+Connect to the Membase (or Memcached) Server for limited read access to some exposed models:
+
+  Neuron::Client::API.default_api.configure do |config|
+    config.connection_type = :membase
+    config.membase_servers = "127.0.0.1:11211"
+  end
+
+  Short form to copy and paste into console:
+
+  Neuron::Client::API.default_api.configure {|config| config.connection_type = :membase; config.membase_servers = '127.0.0.1:11211'}
+
+Create a new API, configure and use it for one specific model:
+
+  api = Neuron::Client::API.new
+  api.configure {|config| config.connection_type = :membase; config.membase_servers = '127.0.0.1:11211'}
+  Neuron::Client::Model::Ad.api = api
 
 Zones
 =====
 
+*Note: many finder methods are not available when using a Membase connection.  Objects are read-only when using a Membase connection.
+
 Create a zone:
 
-    zone = Neuron::Client::Zone.new(:slug => 'test', :response_type => 'Redirect')
+    zone = Neuron::Client::Model::Zone.new(:slug => 'test', :response_type => 'Redirect')
     zone.save
 
 ... or simply:
     
-    Neuron::Client::Zone.create(:slug => 'test', :response_type => 'Redirect')
+    Neuron::Client::Model::Zone.create(:slug => 'test', :response_type => 'Redirect')
 
 List all zones:
 
-    Neuron::Client::Zone.all # => Array of Zone objects (with limited attributes)
+    Neuron::Client::Model::Zone.all # => Array of Zone objects (with limited attributes)
 
 Find a zone by ID:
 
-    Neuron::Client::Zone.find(zone_id)
+    Neuron::Client::Model::Zone.find(zone_id)
 
 Update a zone:
 

data/lib/neuron-client.rb

@@ -1,16 +1,42 @@
+require "active_support/core_ext"
 require "neuron-client/version"
+require "neuron-client/admin_connection"
+require "neuron-client/membase_connection"
 require "neuron-client/api"
-require "neuron-client/connection"
-require "neuron-client/connected"
-require "neuron-client/ad"
-require "neuron-client/ad_zone"
-require "neuron-client/blocked_referer"
-require "neuron-client/blocked_user_agent"
-require "neuron-client/geo_target"
-require "neuron-client/real_time_stats"
-require "neuron-client/report"
-require "neuron-client/s3_file"
-require "neuron-client/zone"
+
+require "neuron-client/model/common/base"
+require "neuron-client/model/common/ad_calculations"
+require "neuron-client/model/common/ad"
+require "neuron-client/model/common/ad_zone"
+require "neuron-client/model/common/blocked_referer"
+require "neuron-client/model/common/blocked_user_agent"
+require "neuron-client/model/common/geo_target"
+require "neuron-client/model/common/report"
+require "neuron-client/model/common/s3_file"
+require "neuron-client/model/common/zone_calculations"
+require "neuron-client/model/common/zone"
+
+require "neuron-client/model/admin/base"
+require "neuron-client/model/admin/ad"
+require "neuron-client/model/admin/ad_zone"
+require "neuron-client/model/admin/blocked_referer"
+require "neuron-client/model/admin/blocked_user_agent"
+require "neuron-client/model/admin/geo_target"
+require "neuron-client/model/admin/report"
+require "neuron-client/model/admin/s3_file"
+require "neuron-client/model/admin/zone"
+
+require "neuron-client/model/membase/ad"
+require "neuron-client/model/membase/ad_zone"
+require "neuron-client/model/membase/blocked_referer"
+require "neuron-client/model/membase/blocked_user_agent"
+require "neuron-client/model/membase/geo_target"
+require "neuron-client/model/membase/report"
+require "neuron-client/model/membase/s3_file"
+require "neuron-client/model/membase/zone"
+
+require "neuron-client/model/base"
+require "neuron-client/model/models"
 
 class Object
   def blank?
@@ -22,4 +48,27 @@ class Object
   def present?
     !self.blank?
   end
-end
+end
+
+# lifted completely from the ruby facets gem source:
+# /lib/core-uncommon/facets/module/cattr.rb
+def Module
+  def cattr_writer(*syms)
+    syms.flatten.each do |sym|
+      module_eval(<<-EOS, __FILE__, __LINE__)
+        unless defined? @@#{sym}
+          @@#{sym} = nil
+        end
+
+        def self.#{sym}=(obj)
+          @@#{sym} = obj
+        end
+
+        def #{sym}=(obj)
+          @@#{sym}=(obj)
+        end
+      EOS
+    end
+    return syms
+  end
+end

data/lib/neuron-client/{connection.rb → admin_connection.rb}

@@ -3,7 +3,7 @@ require 'yajl'
 
 module Neuron
   module Client
-    class Connection
+    class AdminConnection
       def initialize(url, key)
         @url = url
         @key = key
@@ -19,7 +19,7 @@ module Neuron
 
       def get(path="", attrs={})
         format = attrs.delete(:format) || :json
-        RestClient.get("#{@url}/#{[path, format].select(&:present?).join(".")}?#{query_string(attrs)}", 
+        RestClient.get("#{@url}/#{[path, format].select(&:present?).join(".")}?#{query_string(attrs)}",
           format.present? ? {:content_type => format, :accept => format} : {}) do |response, request, result, &block|
           # follow redirection
           if [301, 302, 307].include? response.code
@@ -37,8 +37,8 @@ module Neuron
 
       def post(path="", form={}, attrs={})
         format = attrs.delete(:format) || :json
-        RestClient.post("#{@url}/#{[path, format].select(&:present?).join(".")}?#{query_string(attrs)}", 
-          (format == :json ? Yajl.dump(form) : form), 
+        RestClient.post("#{@url}/#{[path, format].select(&:present?).join(".")}?#{query_string(attrs)}",
+          (format == :json ? Yajl.dump(form) : form),
           format.present? ? {:content_type => format, :accept => format} : {}) do |response, request, result, &block|
           case response.code
           when 201
@@ -53,8 +53,8 @@ module Neuron
 
       def put(path="", form={}, attrs={})
         format = attrs.delete(:format) || :json
-        RestClient.put("#{@url}/#{[path, format].select(&:present?).join(".")}?#{query_string}", 
-          (format == :json ? Yajl.dump(form) : form), 
+        RestClient.put("#{@url}/#{[path, format].select(&:present?).join(".")}?#{query_string}",
+          (format == :json ? Yajl.dump(form) : form),
           format.present? ? {:content_type => format, :accept => format} : {}) do |response, request, result, &block|
           case response.code
           when 200
@@ -69,7 +69,7 @@ module Neuron
 
       def delete(path="", attrs={})
         format = attrs.delete(:format) || :json
-        RestClient.delete("#{@url}/#{[path, format].select(&:present?).join(".")}?#{query_string(attrs)}", 
+        RestClient.delete("#{@url}/#{[path, format].select(&:present?).join(".")}?#{query_string(attrs)}",
           format.present? ? {:content_type => format, :accept => format} : {}) do |response, request, result, &block|
           case response.code
           when 200

data/lib/neuron-client/api.rb

@@ -1,45 +1,62 @@
 module Neuron
   module Client
-
-    # Neuron::Client::API.configure do |config|
-    #   config.admin_url = "https://example.com"
-    #   config.admin_key = "secret"
-    # end
-    # 
-    # Neuron::Client::API.connection
     class API
       autoload :OpenStruct, "ostruct"
-      class << self
-        attr_accessor :connection
+      attr_accessor :connection
 
-        def reset!
-          self.connection = nil
-          @config = nil
-        end
+      def configure
+        yield config
+        inclusion(config, :connection_type, [:admin, :membase])
+
+        configure_admin_connection if config.connection_type == :admin
+        configure_membase_connection if config.connection_type == :membase
+
+        self
+      end
+
+      def connection_type
+        @config.connection_type
+      end
 
-        def configure
-          @config ||= OpenStruct.new
-          yield @config
-          required(@config, :admin_url)
-          required(@config, :admin_key)
-          begin
-            URI.parse(@config.admin_url)
-          rescue
-            raise "Invalid admin_url: #{@config.admin_url}"
-          end
-          self.connection = Connection.new(@config.admin_url, @config.admin_key)
-          true
+      private
+
+      def config
+        @config ||= OpenStruct.new
+      end
+
+      def required(obj, attrib)
+        val = obj.send(attrib)
+        if val.nil? || (val.respond_to?(:empty?) && val.empty?)
+          raise "Missing: #{attrib}"
         end
+      end
 
-        private
+      def inclusion(obj, attrib, valid_values)
+        val = obj.send(attrib)
+        raise "Inclusion: #{attrib} must be one of #{valid_values.join(', ')}" if !valid_values.include?(val)
+      end
 
-        def required(obj, attrib)
-          val = obj.send(attrib)
-          if val.nil? || (val.respond_to?(:empty?) && val.empty?)
-            raise "Missing: #{attrib}"
-          end
+      def configure_admin_connection
+        required(config, :admin_url)
+        required(config, :admin_key)
+        begin
+          URI.parse(config.admin_url)
+        rescue
+          raise "Invalid admin_url: #{config.admin_url}"
         end
+        self.connection = AdminConnection.new(config.admin_url, config.admin_key)
+      end
+
+      def configure_membase_connection
+        required(@config, :membase_servers)
+        self.connection = MembaseConnection.new(config.membase_servers)
+      end
+
+      class << self
+        attr_accessor :default_api
       end
     end
+
+    API.default_api = API.new
   end
 end

data/lib/neuron-client/membase_connection.rb

@@ -0,0 +1,18 @@
+require 'dalli'
+
+module Neuron
+  module Client
+    class MembaseConnection
+
+      attr_reader :client
+
+      def initialize(servers)
+        @client = Dalli::Client.new(servers)
+      end
+
+      def get(key)
+        @client.get(key)
+      end
+    end
+  end
+end

data/lib/neuron-client/model/admin/ad.rb

@@ -0,0 +1,22 @@
+module Neuron
+  module Client
+    module Model
+      module Admin
+        class Ad < Common::Ad
+          include Base
+
+          # deliveries
+          attr_accessor :total_impressed, :today_impressed
+
+          def recent(statistic, parameters)
+            self.class.connection.get("ads/#{id}/recent/#{statistic}", parameters)
+          end
+
+          def unlink(zone_id)
+            self.class.connection.delete("ads/#{id}/zones/#{zone_id}")
+          end
+        end
+      end
+    end
+  end
+end

data/lib/neuron-client/model/admin/ad_zone.rb

@@ -0,0 +1,15 @@
+module Neuron
+  module Client
+    module Model
+      module Admin
+        class AdZone < Common::AdZone
+          include Base
+
+          def self.unlink(ad_id, zone_id)
+            self.connection.delete("zones/#{zone_id}/ads/#{ad_id}")
+          end
+        end
+      end
+    end
+  end
+end

data/lib/neuron-client/model/admin/base.rb

@@ -0,0 +1,91 @@
+module Neuron
+  module Client
+    module Model
+      module Admin
+        module Base
+          def attributes
+            self.class.attributes || []
+          end
+
+          def to_hash(*except)
+            hash = {}
+            attributes.reject{|a| except.collect(&:to_sym).include?(a.to_sym)}.each do |attribute|
+              value = send(attribute)
+              hash[attribute] = value unless value.nil?
+            end
+            hash
+          end
+
+          def new_record?
+            id.nil?
+          end
+
+          def save
+            @errors = catch :errors do
+              if new_record?
+                response = self.class.connection.post("#{self.class.superclass.resources_name}", {self.class.superclass.resource_name => self.to_hash(:errors, :updated_at, :created_at)})
+                self.id = response[self.class.superclass.resource_name][self.class.remote_id]
+              else
+                response = self.class.connection.put("#{self.class.superclass.resources_name}/#{id}", {self.class.superclass.resource_name => self.to_hash(:errors, :updated_at, :created_at)})
+              end
+              []
+            end
+
+            @errors.empty?
+          end
+
+          def update_attributes(attrs={})
+            @errors = catch :errors do
+              response = self.class.connection.put("#{self.class.superclass.resources_name}/#{id}", {self.class.superclass.resource_name => attrs})
+              attrs.each do |key, value|
+                self.send("#{key}=", value) if self.respond_to?("#{key}=")
+              end
+              []
+            end
+
+            @errors.empty?
+          end
+
+          def valid?
+            @errors.empty?
+          end
+
+          def destroy
+            self.class.connection.delete("#{superclass.resources_name}/#{id}")
+          end
+
+          def self.included(base)
+            base.send(:attr_accessor, :errors)
+            base.extend(ClassMethods)
+          end
+
+          module ClassMethods
+            def find(id)
+              response = self.connection.get("#{superclass.resources_name}/#{id}")
+              model = nil
+              model = self.new(response[superclass.resource_name]) if response.present?
+              model
+            end
+
+            def all
+              response = self.connection.get("#{superclass.resources_name}")
+              response.map{|hash| self.new(hash[superclass.resource_name])}
+            end
+
+            def create(attrs={})
+              @errors = catch (:errors) do
+                return create!(attrs)
+              end
+              nil
+            end
+
+            def create!(attrs={})
+              response = self.connection.post("#{superclass.resources_name}", {superclass.resource_name => attrs})
+              self.new(response[superclass.resource_name])
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/neuron-client/model/admin/blocked_referer.rb

@@ -0,0 +1,12 @@
+module Neuron
+  module Client
+    module Model
+      module Admin
+        class BlockedReferer < Common::BlockedReferer
+          include Base
+
+        end
+      end
+    end
+  end
+end