itrigga-admin_api_client 0.1.2 → 0.1.4

data/README.rdoc

@@ -43,14 +43,29 @@ With the HTTP status_code from the remote call and the exception message.
 gem install itrigga-admin_api_client
 
 Put this in the config/environment.rb file:
-config.gem 'itrigga-admin_api_client', :lib => 'trigga/admin_api_client'
+config.gem 'itrigga-admin_api_client', :lib => 'itrigga/admin_api_client'
 
 === Rails3: 
 Put this in the Gemfile:
-gem 'itrigga-admin_api_client', :lib => 'trigga/admin_api_client'
+gem 'itrigga-admin_api_client', :lib => 'itrigga/admin_api_client'
 
 Run 'bundle install'
 
+== Overriding configuration
+
+If the default configuration.yml file is not to your taste it can be overridden by setting ENV['TRIGGA_ADMIN_API_CLIENT_CONFIG_FILE'] to the absolute url of a yml file with the same format to use instead.
+The format needs to be:
+RAILS_ENV:
+  admin:
+    base_url: xxxxxx
+  api:
+    base_url: xxxxxx
+  search_tracker:
+    base_url: xxxxxx
+    
+Where the base_url for each component is an absolute URL
+    
+
 == Contributing to itrigga-admin_api_client
  
 * Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet

data/VERSION

@@ -1 +1 @@
-0.1.2
+0.1.4

data/itrigga-admin_api_client.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{itrigga-admin_api_client}
-  s.version = "0.1.2"
+  s.version = "0.1.4"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Anson Kelly"]
-  s.date = %q{2011-10-11}
+  s.date = %q{2011-10-17}
   s.description = %q{Wraps API calls to iTrigga applications}
   s.email = %q{support@itrigga.com}
   s.extra_rdoc_files = [
@@ -27,11 +27,6 @@ Gem::Specification.new do |s|
     "VERSION",
     "configuration.yml",
     "itrigga-admin_api_client.gemspec",
-    "lib/trigga/admin_api_client.rb",
-    "lib/trigga/admin_api_client/admin_api_client.rb",
-    "lib/trigga/admin_api_client/proxies/admin.rb",
-    "lib/trigga/admin_api_client/proxies/api.rb",
-    "lib/trigga/admin_api_client/proxies/search_tracker.rb",
     "spec/admin_api_client_spec.rb",
     "spec/proxies/admin_spec.rb",
     "spec/proxies/api_spec.rb",

data/spec/admin_api_client_spec.rb

@@ -1,21 +1,21 @@
 require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
 
 
-describe Trigga::AdminApiClient do
+describe Itrigga::AdminApiClient do
   before do
-    Trigga.stub!(:add_log_line).and_return(true) # dont need logging info outputted
+    Itrigga.stub!(:add_log_line).and_return(true) # dont need logging info outputted
   end
   
   it "should include Trigga::ParamFu" do
-    Trigga::AdminApiClient.should include Trigga::ParamFu
+    Itrigga::AdminApiClient.should include Trigga::ParamFu
   end
   
   it "should include Admin proxy" do
-    Trigga::AdminApiClient.should include Trigga::AdminApiClient::Proxies::Admin
+    Itrigga::AdminApiClient.should include Itrigga::AdminApiClient::Proxies::Admin
   end
   
   it "should include API proxy" do
-    Trigga::AdminApiClient.should include Trigga::AdminApiClient::Proxies::Api
+    Itrigga::AdminApiClient.should include Itrigga::AdminApiClient::Proxies::Api
   end
   
   
@@ -23,39 +23,39 @@ describe Trigga::AdminApiClient do
     before do
       TRIGGA_ADMIN_API_CLIENT_CONFIG = {"test" => Hashie::Mash.new(:base_url => "base_url")}
         
-      Trigga::AdminApiClient.stub!(:require_param).and_return(true)
-      Trigga::AdminApiClient.stub!(:build_url).and_return("a url")
+      Itrigga::AdminApiClient.stub!(:require_param).and_return(true)
+      Itrigga::AdminApiClient.stub!(:build_url).and_return("a url")
       Itrigga::NetHelper.stub!(:do_get).and_return({:response => "text"}.to_json)
       @opts = {:api_key => "1234", :abc => 123}
     end
     
     it "should call require_param for api_key" do
-      Trigga::AdminApiClient.should_receive(:require_param).with(@opts, :api_key).and_return(true)
-      Trigga::AdminApiClient.make_call("test","stats",@opts)
+      Itrigga::AdminApiClient.should_receive(:require_param).with(@opts, :api_key).and_return(true)
+      Itrigga::AdminApiClient.make_call("test","stats",@opts)
     end
     
     it "should call build_url with correct params" do
-      Trigga::AdminApiClient.should_receive(:build_url).with("http://base_url","stats",@opts).and_return("a url")
-      Trigga::AdminApiClient.make_call("test","stats",@opts)
+      Itrigga::AdminApiClient.should_receive(:build_url).with("http://base_url","stats",@opts).and_return("a url")
+      Itrigga::AdminApiClient.make_call("test","stats",@opts)
     end
     
     it "should convert the url to absolute" do
-      Trigga::AdminApiClient.should_receive(:make_absolute_url).with("base_url").and_return("http://base_url")
-      Trigga::AdminApiClient.make_call("test","stats",@opts)
+      Itrigga::AdminApiClient.should_receive(:make_absolute_url).with("base_url").and_return("http://base_url")
+      Itrigga::AdminApiClient.make_call("test","stats",@opts)
     end
     
     it "should override the :host" do
-      Trigga::AdminApiClient.should_receive(:make_absolute_url).with("new_base_url").and_return("http://new_base_url")
-      Trigga::AdminApiClient.make_call("test","stats",@opts.merge(:host => "new_base_url"))
+      Itrigga::AdminApiClient.should_receive(:make_absolute_url).with("new_base_url").and_return("http://new_base_url")
+      Itrigga::AdminApiClient.make_call("test","stats",@opts.merge(:host => "new_base_url"))
     end
     
     it "should call net_helper with the url" do
       Itrigga::NetHelper.should_receive(:do_get).with("a url").and_return({:response => "text"}.to_json)
-      Trigga::AdminApiClient.make_call("test","stats",@opts)
+      Itrigga::AdminApiClient.make_call("test","stats",@opts)
     end
     
     it "should return a mash with the status code" do
-      Trigga::AdminApiClient.make_call("test","stats",@opts).should == Hashie::Mash.new(:response => "text", :status_code => 200)
+      Itrigga::AdminApiClient.make_call("test","stats",@opts).should == Hashie::Mash.new(:response => "text", :status_code => 200)
     end
     
     describe "when an error occurs" do
@@ -64,12 +64,12 @@ describe Trigga::AdminApiClient do
       end
       
       it "should return an error mash when errord out" do
-        Trigga::AdminApiClient.make_call("test","stats",@opts).should == Hashie::Mash.new(:error => "500 An error", :status_code => 500 )
+        Itrigga::AdminApiClient.make_call("test","stats",@opts).should == Hashie::Mash.new(:error => "500 An error", :status_code => 500 )
       end
       
       it "should call status_code_from_error" do
-        Trigga::AdminApiClient.should_receive(:status_code_from_error).with("500 An error").and_return(500)
-        Trigga::AdminApiClient.make_call("test","stats",@opts)
+        Itrigga::AdminApiClient.should_receive(:status_code_from_error).with("500 An error").and_return(500)
+        Itrigga::AdminApiClient.make_call("test","stats",@opts)
       end
     end
   end
@@ -77,11 +77,11 @@ describe Trigga::AdminApiClient do
   
   describe "make_endpoint_absolute" do
     it "should add a /" do
-      Trigga::AdminApiClient.make_endpoint_absolute("stats").should == "/stats"
+      Itrigga::AdminApiClient.make_endpoint_absolute("stats").should == "/stats"
     end
     
     it "should not add an extra /" do
-      Trigga::AdminApiClient.make_endpoint_absolute("/stats").should == "/stats"
+      Itrigga::AdminApiClient.make_endpoint_absolute("/stats").should == "/stats"
     end
   end
   
@@ -89,11 +89,11 @@ describe Trigga::AdminApiClient do
   
   describe "build_url" do
     it "should return the correct url" do
-      Trigga::AdminApiClient.build_url("http://site.com","stats",:abc => 123).should == "http://site.com/stats.json?abc=123"
+      Itrigga::AdminApiClient.build_url("http://site.com","stats",:abc => 123).should == "http://site.com/stats.json?abc=123"
     end
     
     it "should use the given format" do
-      Trigga::AdminApiClient.build_url("http://site.com","stats",:abc => 123,:format => "xml").should == "http://site.com/stats.xml?abc=123"
+      Itrigga::AdminApiClient.build_url("http://site.com","stats",:abc => 123,:format => "xml").should == "http://site.com/stats.xml?abc=123"
     end
   end
 
@@ -101,11 +101,11 @@ describe Trigga::AdminApiClient do
   
   describe "status_code_from_error" do
     it "should return the status code" do
-      Trigga::AdminApiClient.status_code_from_error("404 I got lost").should == 404
+      Itrigga::AdminApiClient.status_code_from_error("404 I got lost").should == 404
     end
     
     it "should return 0 when no status" do
-      Trigga::AdminApiClient.status_code_from_error("I got lost").should == 0
+      Itrigga::AdminApiClient.status_code_from_error("I got lost").should == 0
     end
   end
   

data/spec/proxies/admin_spec.rb

@@ -2,14 +2,14 @@ require File.expand_path(File.join(File.dirname(__FILE__),'..', 'spec_helper'))
 
 class AdminApiClientProxyTest
   include Trigga::ParamFu
-  include Trigga::AdminApiClient::Proxies::Admin
+  include Itrigga::AdminApiClient::Proxies::Admin
 end
 
-describe Trigga::AdminApiClient::Proxies::Admin do
+describe Itrigga::AdminApiClient::Proxies::Admin do
   before do
     AdminApiClientProxyTest.stub!(:require_one_of).and_return(true)
     AdminApiClientProxyTest.stub!(:require_param).and_return(true)
-    Trigga::AdminApiClient.stub!(:make_call).and_return(true)
+    Itrigga::AdminApiClient.stub!(:make_call).and_return(true)
     @opts = {:abc => 123, :api_key => "blah"}
   end
   
@@ -19,7 +19,7 @@ describe Trigga::AdminApiClient::Proxies::Admin do
     end
     
     it "should call make_call" do
-      Trigga::AdminApiClient.should_receive(:make_call).with("admin","stats",@opts)
+      Itrigga::AdminApiClient.should_receive(:make_call).with("admin","stats",@opts)
       AdminApiClientProxyTest.new.get_stats @opts
     end
   end
@@ -27,7 +27,7 @@ describe Trigga::AdminApiClient::Proxies::Admin do
   
   describe "get_clients" do
     it "should call make_call" do
-      Trigga::AdminApiClient.should_receive(:make_call).with("admin","clients",@opts)
+      Itrigga::AdminApiClient.should_receive(:make_call).with("admin","clients",@opts)
       AdminApiClientProxyTest.new.get_clients @opts
     end
   end
@@ -44,7 +44,7 @@ describe Trigga::AdminApiClient::Proxies::Admin do
     end
     
     it "should call make_call" do
-      Trigga::AdminApiClient.should_receive(:make_call).with("admin","clients/42",@opts)
+      Itrigga::AdminApiClient.should_receive(:make_call).with("admin","clients/42",@opts)
       AdminApiClientProxyTest.new.get_client @opts
     end
   end

data/spec/proxies/api_spec.rb

@@ -2,14 +2,14 @@ require File.expand_path(File.join(File.dirname(__FILE__),'..', 'spec_helper'))
 
 class ApiApiClientProxyTest
   include Trigga::ParamFu
-  include Trigga::AdminApiClient::Proxies::Api
+  include Itrigga::AdminApiClient::Proxies::Api
 end
 
-describe Trigga::AdminApiClient::Proxies::Api do
+describe Itrigga::AdminApiClient::Proxies::Api do
   before do
     ApiApiClientProxyTest.stub!(:require_one_of).and_return(true)
     ApiApiClientProxyTest.stub!(:require_param).and_return(true)
-    Trigga::AdminApiClient.stub!(:make_call).and_return(true)
+    Itrigga::AdminApiClient.stub!(:make_call).and_return(true)
     @opts = {:abc => 123, :api_key => "blah"}
   end
   
@@ -28,7 +28,7 @@ describe Trigga::AdminApiClient::Proxies::Api do
     end
     
     it "should call make_call filtering out bad params" do
-      Trigga::AdminApiClient.should_receive(:make_call).with("api","endpoint",{:api_key => "blah"})
+      Itrigga::AdminApiClient.should_receive(:make_call).with("api","endpoint",{:api_key => "blah"})
       ApiApiClientProxyTest.new.send("make_api_call","endpoint",@opts)
     end
   end

data/spec/proxies/search_tracker_spec.rb

@@ -2,8 +2,8 @@ require File.expand_path(File.join(File.dirname(__FILE__),'..', 'spec_helper'))
 
 class SearchTrackerApiClientProxyTest
   include Trigga::ParamFu
-  include Trigga::AdminApiClient::Proxies::SearchTracker
+  include Itrigga::AdminApiClient::Proxies::SearchTracker
 end
 
-describe Trigga::AdminApiClient::Proxies::SearchTracker do
+describe Itrigga::AdminApiClient::Proxies::SearchTracker do
 end

data/spec/spec_helper.rb

@@ -1,7 +1,7 @@
 $LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
 $LOAD_PATH.unshift(File.dirname(__FILE__))
 
-require 'trigga/admin_api_client'
+require 'itrigga/admin_api_client'
 
 # Requires supporting files with custom matchers and macros, etc,
 # in ./support/ and its subdirectories.

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: itrigga-admin_api_client
 version: !ruby/object:Gem::Version 
-  hash: 31
+  hash: 19
   prerelease: false
   segments: 
   - 0
   - 1
-  - 2
-  version: 0.1.2
+  - 4
+  version: 0.1.4
 platform: ruby
 authors: 
 - Anson Kelly
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-10-11 00:00:00 +01:00
+date: 2011-10-17 00:00:00 +01:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -256,11 +256,6 @@ files:
 - VERSION
 - configuration.yml
 - itrigga-admin_api_client.gemspec
-- lib/trigga/admin_api_client.rb
-- lib/trigga/admin_api_client/admin_api_client.rb
-- lib/trigga/admin_api_client/proxies/admin.rb
-- lib/trigga/admin_api_client/proxies/api.rb
-- lib/trigga/admin_api_client/proxies/search_tracker.rb
 - spec/admin_api_client_spec.rb
 - spec/proxies/admin_spec.rb
 - spec/proxies/api_spec.rb

data/lib/trigga/admin_api_client.rb

@@ -1,31 +0,0 @@
-# allow this to be used outside of full Rails init
-this_dir =  File.dirname(__FILE__)
-$: << this_dir unless $:.include?(this_dir)
-
-#require 'faster_csv'
-require 'yaml'
-require 'hashie'
-require 'core_ext'
-require 'trigga/param_fu'
-require 'net_helper'
-
-#require 'trigga/param_fu'
-Dir[File.join(File.dirname(File.expand_path(__FILE__)),"admin_api_client","proxies","*.rb")].each {|f| require f }
-Dir[File.join(File.dirname(File.expand_path(__FILE__)),"admin_api_client","*.rb")].each {|f| require f }
-
-# load configuration
-unless defined? RAILS_ENV
-  RAILS_ENV = ENV['RAILS_ENV'] || ENV['RACK_ENV'] || "development"
-end
-
-Trigga.add_log_line("", true)
-Trigga.add_log_line(" iTrigga Admin Client API")
-Trigga.add_log_line("", true)
- 
-begin
-  plugin_configuration_file = File.join(File.dirname(File.expand_path(__FILE__)),"..","..","configuration.yml")
-  TRIGGA_ADMIN_API_CLIENT_CONFIG = Hashie::Mash.new(YAML.load_file(plugin_configuration_file)[RAILS_ENV])
-rescue Exception => e
-  Trigga.add_log_line("...disabled => Unable to load Admin Client API configuration from #{plugin_configuration_file}.\n")
-  Trigga.add_log_line("Exception: #{e.message}")
-end

data/lib/trigga/admin_api_client/admin_api_client.rb

@@ -1,86 +0,0 @@
-module Trigga
-  module AdminApiClient
-    include Trigga::ParamFu
-    include Trigga::AdminApiClient::Proxies::Admin
-    include Trigga::AdminApiClient::Proxies::Api
-    include Trigga::AdminApiClient::Proxies::SearchTracker
-    
-    private
-    
-    def self.make_call(module_name, endpoint, opts = {})
-      require_param(opts, :api_key)
-      
-      host = make_absolute_url( opts[:host] || TRIGGA_ADMIN_API_CLIENT_CONFIG[module_name].base_url )
-      
-      begin
-        url = build_url(host,endpoint,opts) 
-        Trigga.add_log_line("[API Client] - #{url}")
-        
-        response = JSON.parse(Itrigga::NetHelper.do_get(url))
-        ::Hashie::Mash.new(response.kind_of?(Array) ? default_response : response.merge(default_response) )
-        
-      rescue Exception => e
-         Trigga.add_log_line "[API Client Error] - #{e.message}\n#{e.backtrace.join('\n')}" if RAILS_ENV == "development"
-         ::Hashie::Mash.new(:error => e.message, :status_code => status_code_from_error(e.message))
-      end 
-    end
-    
-    def self.default_response
-      {:status_code => 200}
-    end
-    
-    def self.make_endpoint_absolute(endpoint)
-      endpoint.to_s.match(/^\/{1}.*/) ? endpoint : "/#{endpoint}"
-    end
-    
-    def self.make_absolute_url(url)
-      url.to_s.match(/^https?:\/\//) ? url : "http://#{url}"
-    end
-    
-    def self.build_url(url, endpoint, h = {})
-      # default format to json
-      format = h[:format] || "json"
-      h.delete :format
-      
-      params = h.map { |k, v| "#{k}=#{v}" }.join("&")
-      "#{url}#{make_endpoint_absolute(endpoint)}.#{format}#{params.empty? ? '' : '?' + params}"
-    end    
-    
-    # get the status code from the error message
-    # eg "404 Not Found"
-    def self.status_code_from_error(error)
-      code = error.match(/^(\d{3} )/)
-      if code
-        code.to_s.to_i
-      else 
-        0
-      end
-    end
-    
-  end
-  
-  # ==============================================================================================================================
-  # Prints a debugging info line into the log...
-  # ==============================================================================================================================
-  
-  def self.add_log_line(line, add_padding = false)
-    is_terminal = false
-    begin
-      @terminal_width ||= `stty size`.split.map { |x| x.to_i }.reverse[0]
-      is_terminal = true
-    rescue Exception => e
-      # not running in terminal``
-    end
-    
-    if add_padding and is_terminal and !@terminal_width.nil?
-      puts  "#{line.ljust(@terminal_width - line.length, "=")}\n"
-    else
-      if defined?(Rails.logger)
-        Rails.logger.info line
-      else
-        puts line
-      end
-    end
-  end
-  
-end

data/lib/trigga/admin_api_client/proxies/admin.rb

@@ -1,26 +0,0 @@
-module Trigga
-  module AdminApiClient
-    module Proxies
-      module Admin
-        
-        def self.included(base)
-          base.send("extend",self)
-        end
-        
-        def get_stats( opts = {})
-          Trigga::AdminApiClient.make_call "admin", "stats", opts
-        end
-        
-        def get_clients(opts = {})
-          Trigga::AdminApiClient.make_call "admin", "clients", opts
-        end
-        
-        def get_client(opts = {})
-          require_param(opts, :client_id)
-          Trigga::AdminApiClient.make_call "admin", "clients/#{opts[:client_id]}", opts
-        end
-        
-      end
-    end
-  end
-end

data/lib/trigga/admin_api_client/proxies/api.rb

@@ -1,52 +0,0 @@
-module Trigga
-  module AdminApiClient
-    module Proxies
-      module Api
-
-        def self.included(base)
-          base.send("extend",self)
-        end
-
-        private
-        
-        def common_params
-          [:page, :per_page, :max_tags, :site_key, :api_key]
-        end
-        
-        def make_api_call(endpoint, opts = {})
-          require_one_of( opts, :site_key, :site_id )
-          Trigga::AdminApiClient.make_call("api", endpoint, opts.reject{|k,v| !common_params.include?(k.to_sym) } )
-        end
-        
-        public
-        
-        def get_channels(opts)
-          make_api_call("channels", opts )
-        end
-          
-          def get_channel_items( opts )
-          require_param( opts, :channel_id )
-          make_api_call("channels/#{opts[:channel_id]}", opts )
-        end
-        
-        def get_sources( opts )
-          make_api_call('sources', opts)
-        end
-        
-        def get_item_tags( opts )
-          make_api_call('item_tags', opts)
-        end
-        
-        def get_latest_items( opts )
-          make_api_call('items', opts)
-        end
-        
-        def get_item_details( opts )
-          require_param( opts, :item_id )
-          make_api_call("items/#{opts[:item_id]}", opts)
-        end
-         
-      end
-    end
-  end
-end

data/lib/trigga/admin_api_client/proxies/search_tracker.rb

@@ -1,13 +0,0 @@
-module Trigga
-  module AdminApiClient
-    module Proxies
-      module SearchTracker
-        
-        def self.included(base)
-          base.send("extend",self)
-        end        
-        
-      end
-    end
-  end
-end