admincredible 0.0.1

data/Gemfile

@@ -0,0 +1,12 @@
+source :rubygems
+
+group :development do
+  gem 'nestful'
+  gem 'roauth', :git => 'git://github.com/bookworm/roauth.git'
+end
+
+group :console do
+  gem 'ripl'
+end
+
+gemspec

data/Gemfile.lock

@@ -0,0 +1,86 @@
+GIT
+  remote: git://github.com/bookworm/roauth.git
+  revision: 6e67a5909cf560312f69d2d066b4e477c14d23d5
+  specs:
+    roauth (0.0.7)
+
+PATH
+  remote: .
+  specs:
+    admincredible (0.0.1)
+      active_support
+      faraday (>= 0.8.0)
+      faraday_middleware (>= 0.8.7)
+      hashie
+      inflection
+      json
+      mime-types
+      multipart-post
+      simple_oauth
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    active_support (3.0.0)
+      activesupport (= 3.0.0)
+    activemodel (3.0.0)
+      activesupport (= 3.0.0)
+      builder (~> 2.1.2)
+      i18n (~> 0.4.1)
+    activesupport (3.0.0)
+    addressable (2.3.2)
+    bond (0.4.3)
+    bson (1.8.1)
+    builder (2.1.2)
+    crack (0.3.2)
+    diff-lcs (1.1.3)
+    faraday (0.8.4)
+      multipart-post (~> 1.1)
+    faraday_middleware (0.9.0)
+      faraday (>= 0.7.4, < 0.9)
+    hashie (1.2.0)
+    i18n (0.4.2)
+    inflection (1.0.0)
+    json (1.7.6)
+    mime-types (1.19)
+    mongo (1.8.1)
+      bson (~> 1.8.1)
+    mongo_mapper (0.12.0)
+      activemodel (~> 3.0)
+      activesupport (~> 3.0)
+      plucky (~> 0.5.2)
+    multipart-post (1.1.5)
+    nestful (0.0.8)
+      activesupport (>= 3.0.0.beta)
+    plucky (0.5.2)
+      mongo (~> 1.5)
+    rake (10.0.3)
+    ripl (0.7.0)
+      bond (~> 0.4.2)
+    rspec (2.12.0)
+      rspec-core (~> 2.12.0)
+      rspec-expectations (~> 2.12.0)
+      rspec-mocks (~> 2.12.0)
+    rspec-core (2.12.2)
+    rspec-expectations (2.12.1)
+      diff-lcs (~> 1.1.3)
+    rspec-mocks (2.12.1)
+    simple_oauth (0.2.0)
+    vcr (2.4.0)
+    webmock (1.9.0)
+      addressable (>= 2.2.7)
+      crack (>= 0.1.7)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  admincredible!
+  mongo_mapper
+  nestful
+  rake
+  ripl
+  roauth!
+  rspec
+  vcr
+  webmock

data/Rakefile

@@ -0,0 +1,24 @@
+require 'rake/testtask'
+require 'bundler/gem_tasks'
+
+begin
+  require 'rspec/core/rake_task'
+rescue LoadError
+end
+
+if defined?(RSpec)
+  spec_tasks = Dir['spec/*/'].map { |d| File.basename(d) }
+
+  spec_tasks.each do |folder|
+    RSpec::Core::RakeTask.new("spec:#{folder}") do |t|
+      t.pattern = "./spec/#{folder}/**/*_spec.rb"
+      t.rspec_opts = %w(-fs --color)
+    end
+  end
+
+  desc 'Run complete application spec suite'
+  task 'spec' => spec_tasks.map { |f| "spec:#{f}" }
+
+  desc 'Default: run specs.'
+  task :default => 'spec'
+end

data/Readme.md

@@ -0,0 +1,121 @@
+# A brief explanation of the purposes of this so called "gem"
+
+This gem is for communicating with Joomla! sites running
+[com_admincredible](https://github.com/Admincredible/com_admincredible) a powerful REST API component. We use both the
+component and this gem to deliver an incredible service for updating and managing your Joomla sites. Feel free to check
+it out at [admincredible.com](http://admincredible.com). 
+
+Now that we have got that out of the way let's move onto to how to use this useful thing of a gem.
+
+# How to for geniuses 
+
+It's been scientifically proven in controlled studies that the smarter you are the more documentation you'll read.
+
+## Installation
+You can install using any of the typical methods
+
+### Rubygems
+
+Just do the classic
+
+```sh
+gem install admincredible
+```
+
+### Bundler
+
+Or add it to to your Gemfile
+
+    gem 'admincredible'
+    
+## Getting things done
+
+Our gem runs on the very powerful and flexible [faraday](https://github.com/lostisland/faraday) which means our developer can ignore the hard stuff (*1) focus on providing a mind blowing API (*2). It looks like this.
+
+```ruby
+require 'admincredible'
+require 'simple_oauth'
+
+client = Admincredible::Client.new do |config|
+  ## The url to the site you're using
+  config.url = 'http://localhost/joomla_old_testsite_257'
+  
+  ## An OAuth callback to use during generation of an authorization URL. Optional
+  config.oauth_callback = 'http://google.com'
+  
+  ## OAuth Keys. Optional
+  config.consumer_key    = 'foobarcatsdogs1232442'
+  config.consumer_secret = 'foobarcatsdogs1232442'
+  config.token           = 'foobarcatsdogs1232442fish'
+  config.token_secret    = 'foobarcatsdogs1232442dish'
+end
+```
+1. I hate OAuth. Also, I hate OAuth. 
+2. Admincredble is not responsible for any minds overloaded by the sheer awesomeness of our gem.
+
+## But wait, I don't have any OAuth keys?
+ 
+The gem is here to help with an OAuth resource.
+
+```ruby
+# Require these.
+# Why two oauth libs? Because I had to use my own fork of roauth to sign authorization url's :( 
+# I'll fork simple_oauth soon and add the needed feature for signing urls.
+require 'simple_oauth'
+require 'roauth'
+require 'nestful'
+
+client = Admincredible::Client.new do |config|
+  ## The url to the site you're using
+  config.url            = 'http://localhost/joomla_old_testsite_257'
+  
+  ## An OAuth callback to use during generation of an authorization URL. Optional
+  config.oauth_callback = 'http://google.com'
+end
+
+client.oauth.register          # Register
+client.oauth.request_token     # Get request token
+client.oauth.authorization_url # Redirect your user to this
+
+# After the authorization redirect com_admincredible will post the verification to your callback URL.
+client.oauth.access_token params[:oauth_verifier]
+```
+
+That is it. Good luck on your journey into admincredible land.
+
+# Usage Tips. The stress and tension headache prevention section
+
+Usage tips are important for those power users that like to push the limits of what is possible
+and in the process push the limits of their tolerance for frustration. 
+
+## Gotchas
+
+### Updating Extension
+
+Extensions in Joomla! don't like to update if they exceed PHP execution limits, the only way around this is to keep
+trying until they do. Sometimes a Joomla extension will even decide to finish an update in the background. This means
+that sometimes the gem will return update details and other times it will simply return `{"status"=>200,
+"data"=>{"success"=>true}, "message"=>"Nothing To Update"}`.
+
+That means it's up to you to keep track of what extensions you requested updates for and to figure out if they failed or
+succeeded   by calling `client.extensions.all` after calling updates.
+
+If you keep track of what extensions need updating by first calling `client.extensions.all` you can work around the
+problem. I know you can, because I did. I cant give you the solution though, it's part of the secret brew that makes up
+our app.
+
+## Other Tips
+
+1. Carry a towel
+2. Always know where your towel is
+
+# Development
+
+## Running Tests
+
+`$ bundle exec rake spec` should handle everything. It's all fixtured :). If you'd like to run tests live you can setup
+a site to run at `http://localhost/joomla_old_testsite_257` and set it's authenticator to `debug` 
+
+# License
+
+GPL V3

data/TODOS

@@ -0,0 +1 @@
+- fix usage of two oauth libraries

data/admincredible.gemspec

@@ -0,0 +1,35 @@
+Gem::Specification.new do |s|
+  s.required_ruby_version     = '>= 1.8.7'
+  s.required_rubygems_version = '>= 1.3.6'
+  
+  # Details
+  s.name             = 'admincredible'
+  s.version          = '0.0.1'
+  s.authors          = ['Ken Erickson"']
+  s.date             = '2013-01-19'
+  s.summary          = 'Communicates with com_admincredible, a Joomla! extension that adds REST like APIs to Joomla installs'
+  s.description      = 'Communicates with com_admincredible, a Joomla! extension that adds REST like APIs to Joomla installs'
+  s.email            = 'bookworm.productions@gmail.com'
+  s.files            = `git ls-files`.split("\n")
+  s.test_files       = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.homepage         = 'http://admincredible.com'
+  s.require_paths    = ['lib']
+
+  # Dependencies 
+  s.add_runtime_dependency 'active_support'
+  s.add_runtime_dependency 'simple_oauth'
+  s.add_runtime_dependency 'faraday', '>= 0.8.0'
+  s.add_runtime_dependency 'faraday_middleware', '>= 0.8.7'
+  s.add_runtime_dependency 'hashie'
+  s.add_runtime_dependency 'inflection'
+  s.add_runtime_dependency 'json'
+  s.add_runtime_dependency 'mime-types'
+  s.add_runtime_dependency 'multipart-post'
+
+  # Development Dependencies
+  s.add_development_dependency 'rake'
+  s.add_development_dependency 'vcr'
+  s.add_development_dependency 'rspec'
+  s.add_development_dependency 'mongo_mapper'
+  s.add_development_dependency 'webmock'
+end

data/developer_notes/README.md

@@ -0,0 +1,2 @@
+The developer keeps random thoughts in this directory. They are not meant to interpreted as documentation and are
+guaranteed to be full of inaccuracies and poor grammar.

data/lib/admincredible.rb

@@ -0,0 +1 @@
+require 'admincredible/client'

data/lib/admincredible/client.rb

@@ -0,0 +1,60 @@
+require 'faraday'
+require 'faraday_middleware'
+require 'active_support'
+require 'active_support/core_ext/string'
+require 'admincredible/core_ext/string'
+
+require 'admincredible/configuration'
+require 'admincredible/connection'
+require 'admincredible/request'
+require 'admincredible/joomla_request'
+require 'admincredible/resource'
+
+Dir[File.dirname(__FILE__) + '/resources/*.rb'].each  { |file| require file }
+Dir[File.dirname(__FILE__) + '/middleware/*.rb'].each { |file| require file }
+
+module Admincredible
+  class Client
+    include Connection
+    include Request
+    include JoomlaRequest
+    attr_reader :config
+
+    def initialize
+      raise ArgumentError, 'block not given' unless block_given?
+
+      @config = Admincredible::Configuration.new
+      yield config
+
+      @resource_cache = {}
+
+      if config.logger.nil? || config.logger == true
+        require 'logger'
+        config.logger       = Logger.new($stderr)
+        config.logger.level = Logger::WARN
+      end
+    end
+    
+    ## 
+    # A user tries a missing method on our client, we assume it's a resource class and look it up in
+    # Admincredible::Resources. For example, calling client.extensions.all, becomes 
+    # Admincredible::Resources::Extension.new().all
+    #
+    # Instances are cached, so this can be said to be sorta implementing that fancy schmancy singleton pattern
+    # all those cool developers are using. 
+    #
+    def method_missing(method, *args, &block)
+      method  = method.to_s
+      options = args.last.is_a?(Hash) ? args.pop : {}
+
+      @resource_cache[method] ||= {}
+
+      if !options[:reload] && (cached = @resource_cache[method][options.hash])
+        cached
+      else
+        resource_class = Admincredible::Resources.const_get(method.singularize.modulize)
+        @resource_cache[method][options.hash] = resource_class.new(self, options)
+      end
+    end
+  end
+end

data/lib/admincredible/configuration.rb

@@ -0,0 +1,125 @@
+module Admincredible
+  class Configuration
+    # URL + Path Options
+
+    ## 
+    # @return [String] Required. URL of site.
+    #
+    attr_accessor :url
+
+    ##
+    # @return [String] Optional. The direct endpoint to the component. 
+    #   Defaults to '/components/com_admincredible/direct.php'
+    #
+    attr_accessor :direct_endpoint
+
+    ##
+    # @return [String] Optional. The main endpoint (frontend) for the component.
+    #   Defaults to '/index.php?option=com_admincredible&view=authorize'
+    attr_accessor :main_endpoint
+
+    ## 
+    # @return [Symbol] Optional. The authenticator type to use. Not used right now but here for future flexibility
+    #   When using gem you should set it just be safe. Defaults to :debug
+    #
+    attr_accessor :authenticator
+
+    # Oauth Options
+
+    ##
+    # @return [String] Optional. OAuth Consumer Key.
+    #
+    attr_accessor :consumer_key
+
+    ##
+    # @return [String] Optional. OAuth Consumer Secret.
+    #
+    attr_accessor :consumer_secret
+
+    ##
+    # @return [String] Optional. OAuth Token.
+    #
+    attr_accessor :token
+
+    ##
+    # @return [String] Optional. OAuth Token Secret.
+    #
+    attr_accessor :token_secret
+
+    ##
+    # @return [String] Optional. OAuth callback URL.
+    attr_accessor :oauth_callback
+
+    # Faraday options
+
+    ## 
+    # @return [Hash] Optionals. Options to pass to Faraday
+    attr_accessor :connection_options
+
+    ## 
+    # @return [Mixed] Optional. Faraday adapter
+    #
+    attr_accessor :adapter
+
+    # Misc Options
+
+    ##
+    # @return [Integer] Optional. How quickly do we step an Akeeba restoration script? Defaults to 1 second.
+    attr_accessor :step_after_seconds
+
+    ##
+    # @return [Logger] Optional. An instance of an Logger or can be set to true to enable default logger
+    #
+    attr_accessor :logger
+
+    def initialize 
+      @connection_options = {}
+      @direct_endpoint    = '/components/com_admincredible/direct.php'
+      @main_endpoint      = '/index.php?option=com_admincredible&view=authorize'
+      @step_after_seconds = 1
+    end
+
+    def oauth?
+      return true if @consumer_secret || @authenticator == :oauth
+    end
+
+    def url=(url)
+      @url = url.gsub(@direct_endpoint, '')
+    end
+    
+    ## 
+    # Returns the url with the endpoint 
+    #
+    # @return [String]
+    def url
+      return @url + @direct_endpoint
+    end
+
+    ## 
+    # Returns the raw url that was set during configuration of the client
+    #
+    # @return [String]
+    def raw_url
+      return @url
+    end
+
+    def oauth_options
+      return {
+        :consumer_key    => @consumer_key,
+        :consumer_secret => @consumer_secret,
+        :token           => @token,
+        :token_secret    => @token_secret
+      }
+    end
+
+    def connection_options
+      {
+        :headers => {
+          :accept     => 'application/json',
+          :user_agent => 'Admincredible Ruby Gem'
+        },
+        :url => url
+      }.merge(@connection_options)
+    end
+  end
+end