admincredible 0.0.1

data/lib/admincredible/connection.rb

@@ -0,0 +1,30 @@
+module Admincredible
+  module Connection
+    def connection
+      @connection ||= build_connection
+      return @connection
+    end
+   
+    def rebuild_connection
+      @connection = build_connection
+    end
+
+    def build_connection
+      Faraday.new(config.connection_options) do |builder|
+        # Response
+        builder.use Faraday::Response::RaiseError
+        builder.use Admincredible::Middleware::Response::Logger, config.logger if config.logger
+        builder.response :json, :content_type => 'application/json'
+
+        # Request
+        builder.use Faraday::Request::OAuth, config.oauth_options if config.oauth?
+        builder.request :multipart
+        builder.request :json
+        builder.request :retry, 2 unless config.oauth?
+        builder.request :step     unless config.oauth?
+
+        builder.adapter config.adapter || Faraday.default_adapter
+      end
+    end
+  end
+end

data/lib/admincredible/core_ext/string.rb

@@ -0,0 +1,16 @@
+class String
+  ##
+  # Transforms a string into a module name. 
+  #
+  # We at String Transforming Enterprise, Inc, TM, LLC, Corp, believe in three things; 
+  # 1. All strings should be allowed to be whatever string they like. 
+  # 2. ?? 
+  # 3. Profit
+  #
+  def modulize
+    self.gsub(/__(.?)/){ "::#{$1.upcase}" }.
+      gsub(/\/(.?)/){ "::#{$1.upcase}" }.
+      gsub(/(?:_+|-+)([a-z])/){ $1.upcase }.
+      gsub(/(\A|\s)([a-z])/){ $1 + $2.upcase }
+  end
+end

data/lib/admincredible/joomla_request.rb

@@ -0,0 +1,22 @@
+# Due to the fact Joomla cant handle decent URLs (at least not out of the box) 
+# we abstract the requests further. all these methods take a resource + task and then any other 
+# has GET request vars, finally it takes normal options.
+module Admincredible
+  module JoomlaRequest
+    def jget(resource, task, options={})
+      get('', {:resource => resource, :task => task}.merge(options))
+    end
+
+    def jpost(resource, task, options={})
+      post('', options, {:resource => resource, :task => task})
+    end
+
+    def jput(resource, task, options={})
+      put('', options, {:resource => resource, :task => task})
+    end
+
+    def jdelete(resource, task, options={})
+      delete('', {:resource => resource, :task => task}.merge(options))
+    end
+  end
+end

data/lib/admincredible/middleware/logger.rb

@@ -0,0 +1,51 @@
+require 'faraday_middleware/response_middleware'
+
+module Admincredible
+  module Middleware
+    module Response
+      ##
+      # So you're sitting there and you're staring off into the abyss of your terminal,
+      # the solarized green color scheme begins to sink into your retinas and the anger begins to build.
+      # This class prevents hulk moments from occurring and automagically logs requests in when enable via config.
+      #
+      class Logger < Faraday::Response::Middleware
+        def initialize(app, logger = nil)
+          super(app)
+          @logger = logger || begin
+            require 'logger'
+            ::Logger.new(STDOUT)
+          end
+        end
+         
+        def call(env)
+          @logger.info "#{env[:method]} #{env[:url].to_s}"
+          @logger.debug dump_debug(env, :request_headers)
+          super
+        end
+
+        def on_complete(env)
+          @logger.info("Status #{env[:status].to_s}")
+          @logger.debug dump_debug(env, :response_headers)
+        end
+
+        private
+        
+        ##
+        # Dumps things, but safely, like a cat diligently using the litter box.
+        # It won't dump things that are nil and will make sure to inspect the objects first,
+        # if they are found to be carrying in countraband they'll be mapped and joined; which is probably code for
+        # something rather sinister.
+        # Remember cats, sand irst (safety), dump second,
+        #
+        def dump_debug(env, headers_key)
+          info = env[headers_key].map { |k, v| "  #{k}: #{v.inspect}" }.join("\n")
+          unless env[:body].nil?
+            info.concat("\n")
+            info.concat(env[:body].inspect)
+          end
+          info
+        end
+      end
+    end
+  end
+end

data/lib/admincredible/middleware/step.rb

@@ -0,0 +1,44 @@
+require 'faraday/middleware'
+
+module Admincredible
+  module Middleware
+    module Request
+      ##
+      # Akeeba powered restoration scripts use a step/ping methodology that avoids timing out servers.
+      # This will automatically send more requests when a step response is received.
+      #
+      # It sadly doesn't work with OAuth yet because the re-signing requests problem was too difficult for this dev too 
+      # solve at the time of this writing.
+      # 
+      # @todo Fix this for OAuth
+      #
+      # If many months pass before this is resolved you can blame the developer's intense devotion to getting other things 
+      # done. You can probably motivate him to fix it for oauth by bribing him with books. 
+      #
+      class Step < Faraday::Middleware
+        DEFAULT_RETRY_AFTER = 1
+        
+        def initialize(app, options={})
+          super(app)
+        end
+
+        def call(env)
+          response = @app.call(env)
+         
+          if response.env[:status] == 202
+            seconds_left = DEFAULT_RETRY_AFTER
+
+            seconds_left.times do |i|
+              sleep 1
+            end
+
+            call(env)
+          else
+            response
+          end
+        end
+      end
+    end
+  end
+end
+Faraday.register_middleware :request, :step => Admincredible::Middleware::Request::Step

data/lib/admincredible/request.rb

@@ -0,0 +1,47 @@
+module Admincredible
+  module Request
+    # Perform an HTTP GET request
+    def get(path, options={})
+      request(:get, path, options)
+    end
+
+    # Perform an HTTP POST request
+    def post(path, options={}, path_options={})
+      request(:post, path, options, path_options)
+    end
+
+    # Perform an HTTP PUT request
+    def put(path, options={}, path_options={})
+      request(:put, path, options, path_options)
+    end
+
+    # Perform an HTTP DELETE request
+    def delete(path, options={})
+      request(:delete, path, options)
+    end
+
+    private
+    
+    def request(method, path, options={}, path_options={})
+      response = false
+      begin
+        response = connection.send(method) do |request|
+          case method
+          when :get, :delete
+            request.url(path, options)
+          when :post, :put
+            request.path   = path
+            request.params = path_options
+            request.body   = options unless options.empty?
+          end
+        end
+      rescue Faraday::Error::ClientError => e
+        response = e.response
+      end
+
+      return response.body   if response.respond_to?(:body)
+      return response[:body] if response.is_a?(Hash)
+      return response
+    end
+  end
+end

data/lib/admincredible/resource.rb

@@ -0,0 +1,20 @@
+module Admincredible
+  class Resource
+    attr_reader :client
+  
+    ##
+    # Initializes with a client. You can use resource classes directly by passing and instance of Admincredible::Client
+    #
+    def initialize(client, options={})
+      @client = client
+    end
+
+    def connection
+      return client.connection
+    end
+
+    def config
+      return client.config
+    end
+  end
+end

data/lib/admincredible/resources/Backup.rb

@@ -0,0 +1,34 @@
+module Admincredible
+  module Resources
+    class Backup < Resource
+      def start
+        client.jget('backups', 'start')
+      end
+
+      def step(repeat_until_done=true)
+        response = client.jget('backups', 'step')
+
+        if response['status'] == 'working' && repeat_until_done
+          seconds_left = config.step_after_seconds
+
+          seconds_left.times do |i|
+            sleep 1
+          end
+
+          return step
+        end
+
+        response
+      end
+
+      def create
+        response = start
+        if response['status'] == 302
+          return step
+        else
+          return response
+        end
+      end
+    end
+  end
+end

data/lib/admincredible/resources/Compatibility.rb

@@ -0,0 +1,13 @@
+module Admincredible
+  module Resources
+    class Compatibility < Resource
+      def status
+        client.jget('compatibility', 'status')['data']
+      end
+
+      def add_exceptions
+        client.jget('compatibility', 'add_exceptions', {:accept_terms => true})
+      end
+    end
+  end
+end

data/lib/admincredible/resources/Extension.rb

@@ -0,0 +1,37 @@
+module Admincredible
+  module Resources
+    class Extension < Resource
+      def all
+        client.jget('extensions', 'index')['data']['extensions']
+      end
+      alias :index :all
+
+      def update(extension_ids=[], repeat_until_response=true)
+        unless config.oauth?
+          client.rebuild_connection
+          connection.builder.request :retry, 18 
+        end
+        
+        response = nil
+        begin
+          response = client.jget('extensions', 'update', :extension_ids => extension_ids)
+        rescue Faraday::Error::TimeoutError => e
+          if repeat_until_response && config.oauth?
+            seconds_left = config.step_after_seconds
+
+            seconds_left.times do |i|
+              sleep 1
+            end
+
+            return update(extension_ids)
+          else
+            response = false
+          end
+        end
+        
+        client.rebuild_connection unless config.oauth?
+        response
+      end
+    end
+  end
+end

data/lib/admincredible/resources/Oauth.rb

@@ -0,0 +1,53 @@
+module Admincredible
+  module Resources
+    class Oauth < Resource
+      def register
+        response = client.jget('oauth', 'register')
+        return response unless response['status'] == 200
+
+        config.consumer_key    = response['data']['osr_consumer_key']
+        config.consumer_secret = response['data']['osr_consumer_secret']
+
+        client.rebuild_connection
+        return response['data']
+      end
+
+      def request_token
+        response = client.jget('oauth', 'request_token')
+        return response unless response['status'] == 200
+        
+        config.token        = response['data']['request_token']['oauth_token']
+        config.token_secret = response['data']['request_token']['oauth_token_secret']
+
+        client.rebuild_connection
+        return response['data']['request_token']
+      end
+
+      def authorization_url
+        url    = config.url.gsub(config.direct_endpoint, config.main_endpoint)
+        url    = URI.parse(url)
+        params = CGI.parse(url.query)
+
+        return ROAuth.sign_url(config.oauth_options, url.scheme + '://' + url.host + url.path, params.merge({:oauth_callback => config.oauth_callback}))
+      end
+
+      def access_token(oauth_verifier)       
+        params = {
+          :resource       => 'oauth',
+          :task           => 'access_token',
+          :oauth_token    => config.token,
+          :oauth_verifier => oauth_verifier
+        }
+        oauth_header = ROAuth.header(config.oauth_options, config.url, params)
+        response     = JSON.parse(Nestful.get(config.url, :params => params, :headers => {'Accept' => 'application/json', 'Authorization' => oauth_header}))
+        return response unless response['status'] == 200
+        
+        config.token        = response['data']['access_token']['oauth_token']
+        config.token_secret = response['data']['access_token']['oauth_token_secret']
+
+        client.rebuild_connection
+        return response['data']['access_token']
+      end
+    end
+  end
+end

data/lib/admincredible/resources/Setting.rb

@@ -0,0 +1,21 @@
+module Admincredible
+  module Resources
+    class Setting < Resource
+      def all
+        client.jget('settings', 'index')['data']
+      end
+
+      def first
+        client.jget('settings', 'read')['data']
+      end
+
+      def create(*args)
+        client.jpost('settings', 'create', args.extract_options!)['data']
+      end
+
+      def update(*args)
+        client.jpost('settings', 'update', args.extract_options!)['data']
+      end
+    end
+  end
+end

data/lib/admincredible/resources/Site.rb

@@ -0,0 +1,9 @@
+module Admincredible
+  module Resources
+    class Site < Resource
+      def configuration
+        client.jget('site', 'configuration')['data']
+      end
+    end
+  end
+end

data/lib/admincredible/resources/Upgrade.rb

@@ -0,0 +1,64 @@
+module Admincredible
+  module Resources
+    class Upgrade < Resource
+      def info
+        client.jget('upgrade', 'info')['data']
+      end
+
+      def download
+        client.jget('upgrade', 'download')
+      end
+
+      def create_restoration_file
+        client.jget('upgrade', 'create_restoration_file')
+      end
+
+      def start
+        client.jget('upgrade', 'start')
+      end
+
+      def step(repeat_until_done=true)
+        response = client.jget('upgrade', 'step')
+
+        if response['status'] == 'working' && repeat_until_done
+          seconds_left = config.step_after_seconds
+
+          seconds_left.times do |i|
+            sleep 1
+          end
+
+          return step
+        end
+
+        response
+      end
+
+      def finalize
+        client.jget('upgrade', 'finalize')
+      end
+
+      def cleanup
+        client.jget('upgrade', 'cleanup')
+      end
+
+      def create
+        response = download
+        return response unless response['status'] == 200
+
+        response = create_restoration_file
+        return response unless response['status'] == 200
+
+        response = start
+        return response unless response['status'] == 302
+
+        response = step
+        return response unless response['status'] == 200
+
+        response = finalize
+        return response unless response['status'] == 200
+
+        return cleanup
+      end
+    end
+  end
+end