rapidash 0.1.2 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a24e88b9990655513929505bdfded740ae3bc5d0
-  data.tar.gz: 10b580d030b0db97f695b353bdcbc8f4f5046fa9
+  metadata.gz: a317197b608c00d1116ad4be65b62238b0a98034
+  data.tar.gz: cdc69d6da7a4e33c58d83d0fc89e1b0a70cfb72c
 SHA512:
-  metadata.gz: 737c8447bca4d1c56110fa957f7cfe5fa0e8752baf9a7974f8a3e5cbec657e6f30bd0740a1ecbdffe17d0b1a57dc09a667e86243f5a69d511871713cea291fb8
-  data.tar.gz: dcaa32a236b129363fc317b2219c69954e85216d10c9403b8431730b8dfd2e40b0d42014374497e4eaeba94532d318cf440405ef61416bedaed8914d4b962d09
+  metadata.gz: c85000a1ed1351fadcfc1567a4469d54c4920a23eb8e6aa6e60de579b2b6abdd4867179eb7bbc2c844c6c9d745d8ec95ef4114d6c05312c4abdb4e33a3a06751
+  data.tar.gz: 71ef9f5d5e1669de47f6681a86c9c541b7712d9cc29b57add9cc4cd86ac15acbb73f20fc0c972881bfebbd38088dc86c92e720f9476781c84cbe2766d1ed94cc

data/.gitignore

@@ -16,3 +16,4 @@ test/tmp
 test/version_tmp
 tmp
 *.sw[a-z]
+.idea

data/README.md

@@ -25,6 +25,10 @@ A screencast on Rapidash is available to watch in mp4 and ogv formats.
  * [Rapidash Screencast mp4](http://screencasts.gazler.com/rapidash.mp4)
  * [Rapidash Screencast ogv](http://screencasts.gazler.com/rapidash.ogv)
 
+### Sample Rails app
+
+A sample rails app is available at [https://github.com/Gazler/rapidash-tester](https://github.com/Gazler/rapidash-tester) it provides a rails server and a Rapidash client.  Please note that the client is also used as a form of integration test for rapidash.
+
 ### Resources
 
 Resources can be defined as follows:
@@ -37,7 +41,7 @@ end
 The URL of the resource will be inferred from the class name.  In this case Users.  If you want to override that, you can with the url method.
 
 ```ruby
-class Users < Rapidash::Base
+class User < Rapidash::Base
   url :members  # or url "members" is also supported
 end
 ```
@@ -45,10 +49,10 @@ end
 Resources can exist inside other resources.  For example, on Github, a user has repositories.  The following could be how you build the resources:
 
 ```ruby
-class Repos < Rapidash::Base
+class Repo < Rapidash::Base
 end
 
-class Users < Rapidash::Base
+class User < Rapidash::Base
   resource :repos
 end
 ```
@@ -58,7 +62,7 @@ end
 A root element can be set for create and post actions
 
 ```ruby
-class Posts < Rapidash::Base
+class Post < Rapidash::Base
 end
 
 client.posts.create!({:post => {:name => "a post"}})
@@ -67,13 +71,28 @@ client.posts.create!({:post => {:name => "a post"}})
 With a root element, the code would look like this:
 
 ```ruby
-class Posts < Rapidash::Base
+class Post < Rapidash::Base
   root :post
 end
 
 client.posts.create!(:name => "a post")
 ```
 
+### Class Names and Classes In Different Modules
+
+If you wish to use a class in a different module or a class with a different name as the class for your resource then you can use the `:class_name` option.
+
+```ruby
+module MyModule
+  class MyResource < Rapidash::Base
+  end
+end
+
+class AnotherResource < Rapidash::Base
+  resource :my_cool_resource, :class_name => "MyModule::MyResource"
+end
+```
+
 ### Client
 
 The main thing a client must do is define a method, `oauth` and `http` are currently supported.  You can also define resources which links a resource as defined above to the client.
@@ -115,6 +134,7 @@ client.users(1).delete!                                 #DELETE requst to /users
 require 'rapidash'
 
 class Me < Rapidash::Base
+  url "me"
 end
 
 class Facebook < Rapidash::Client
@@ -136,9 +156,9 @@ p client.me!.first_name #Gary
 ```ruby
 require 'rapidash'
 
-class Repos < Rapidash::Base
+class Repo < Rapidash::Base
 
-class Users < Rapidash::Base
+class User < Rapidash::Base
   resource :repos
 end
 
@@ -153,13 +173,30 @@ p client.users!("Gazler").name           #Gary Rennie
 p client.users("Gazler").repos![0].name  #Githug
 ```
 
+### HTTP Authentication
+
+```ruby
+require 'rapidash'
+
+class Client < Rapidash::Client
+  method :http
+  site "your site"
+end
+
+client = Client.new({
+  :login => "your login",
+  :password => "your password",
+})
+```
+
 ## Contributing
 
 1. Fork it
 2. Create your feature branch (`git checkout -b my-new-feature`)
 3. Commit your changes (`git commit -am 'Add some feature'`)
-4. Push to the branch (`git push origin my-new-feature`)
-5. Create new Pull Request
+4. Write your tests, start and check coverage: open file coverage/index.html in your browser. Must be 100.0% covered
+5. Push to the branch (`git push origin my-new-feature`)
+6. Create new Pull Request (into the development branch)
 
 ## Credits
 

data/examples/github.rb

@@ -1,23 +1,23 @@
 require 'rapidash'
 
-class Repos < Rapidash::Base
+class Repo < Rapidash::Base
   def repo!(owner, repo)
     self.url += "/#{owner}/#{repo}"
     call!
   end
 end
 
-class Users < Rapidash::Base
+class User < Rapidash::Base
   resource :repos
 end
 
-class Emojis < Rapidash::Base
+class Emoji < Rapidash::Base
 end
 
-class Events < Rapidash::Base
+class Event < Rapidash::Base
 end
 
-class Gists < Rapidash::Base
+class Gist < Rapidash::Base
 
   def public!
     self.url += "/public"
@@ -26,7 +26,7 @@ class Gists < Rapidash::Base
 
 end
 
-class Organisations < Rapidash::Base
+class Organisation < Rapidash::Base
   url "orgs"
 end
 

data/lib/rapidash.rb

@@ -1,10 +1,12 @@
+#Required for pluralization and camelcasing
+require "active_support/core_ext/string"
+
 require "rapidash/version"
 
 require "rapidash/errors"
 
 require "rapidash/response"
 
-require "rapidash/clientable"
 require "rapidash/resourceable"
 require "rapidash/client"
 

data/lib/rapidash/base.rb

@@ -1,6 +1,5 @@
 module Rapidash
   class Base
-
     include Urlable
     include Resourceable
 
@@ -24,7 +23,7 @@ module Rapidash
 
       @options ||= {}
       @options.merge!(options || {})
-      @url = "#{base_url}#{self.class.to_s.split("::")[-1].downcase}"
+      @url = "#{base_url}#{resource_url}"
       @url += "/#{@id}" if @id
     end
 
@@ -55,21 +54,24 @@ module Rapidash
       client.send(method, url, options)
     end
 
+
     private
 
     def set_body!(params)
       if self.class.root_element
-        options[:body] = {self.class.root_element => params}.to_json
+        options[:body] = {self.class.root_element => params}
       else
-        options[:body] = params.to_json
+        options[:body] = params
       end
     end
 
     def base_url
-      if old_url = self.options[:previous_url]
-        return "#{old_url}/"
-      end
-      ""
+      old_url = self.options[:previous_url]
+      old_url ? "#{old_url}/" : ""
+    end
+
+    def resource_url
+      self.options[:url] || self.class.to_s.split("::")[-1].downcase.pluralize
     end
   end
 end

data/lib/rapidash/client.rb

@@ -1,12 +1,65 @@
 module Rapidash
   class Client
-    include Clientable
     include Resourceable
 
+    attr_accessor :extension
+
     def initialize
       raise ConfigurationError.new "Missing Method, define using `method` on your client"
     end
 
+    class << self
+      attr_accessor :patch, :raise_error
+
+      def method(method)
+        case method
+        when :http then include HTTPClient
+        when :oauth then include OAuthClient
+        when :test then include TestClient
+        else
+          raise ConfigurationError.new "Invalid API Authentication Method"
+        end
+      end
+
+      def use_patch
+        @patch = true
+      end
+
+      def extension(extension = nil)
+        @extension ||= extension
+      end
+
+      def site(site = nil)
+        @site ||= site
+      end
+
+      def raise_errors
+        @raise_error = true
+      end
+    end
+
+    # Instance methods
+
+    def site
+      return @site if @site
+      self.class.respond_to?(:site) && self.class.site
+    end
+
+    def site=(value)
+      @site = value
+      @connection = nil
+    end
+
+    def normalize_url(url)
+      if extension
+        "#{url}.#{extension}"
+      elsif self.class.respond_to?(:extension) && self.class.extension
+        "#{url}.#{self.class.extension}"
+      else
+        url
+      end
+    end
+
     def get(url, options = {})
       request(:get, url, options)
     end
@@ -26,6 +79,5 @@ module Rapidash
     def delete(url, options = {})
       request(:delete, url, options)
     end
-
   end
 end

data/lib/rapidash/http_client.rb

@@ -2,37 +2,32 @@ require 'faraday'
 
 module Rapidash
   module HTTPClient
-
-    def self.included(base)
-      base.extend(ClassMethods)
-    end
-
-    attr_accessor :extension, :site
+    attr_accessor :login, :password
     attr_writer :connection
 
-    def initialize
-    end
-
-    def site=(site)
-      @site = site
-      @connection = nil
+    def initialize(options = {})
+      [:login, :password].each do |key|
+        self.send("#{key.to_s}=".to_sym, options[key])
+      end
     end
 
     def connection
-      @connection ||= Faraday.new(site || self.class.site_url)
+      raise ConfigurationError.new "Site is required" unless site
+      @connection ||= Faraday.new(site)
     end
 
     def request(verb, url, options = {})
-      if extension
-        url = "#{url}.#{(extension)}"
-      elsif self.class.respond_to?(:url_extension) && self.class.url_extension
-        url = "#{url}.#{(self.class.url_extension)}"
+      url = connection.build_url(normalize_url(url), options[:params]).to_s
+      response = connection.run_request verb, url, options[:body], options[:header] do |request|
+        request.headers.update(:Authorization => connection.basic_auth(login, password)) if login && password
       end
-      url = connection.build_url(url, options[:params]).to_s
-      response = connection.run_request(verb, url, options[:body], options[:headers])
 
+      process_response(response, verb, options)
+    end
+
+    def process_response(response, verb, options)
       # "foo"[0] does not work in 1.8.7, "foo"[0,1] is required
-      case response.status.to_s[0,1]
+      case response.status.to_s[0, 1]
       when "5", "4"
         error = ResponseError.new(response)
         raise error if self.class.respond_to?(:raise_error) && self.class.raise_error
@@ -44,15 +39,5 @@ module Rapidash
         return Response.new(response)
       end
     end
-
-
-
-    module ClassMethods
-      attr_accessor :site_url
-
-      def site(site)
-        @site_url = site
-      end
-    end
   end
 end

data/lib/rapidash/oauth_client.rb

@@ -3,29 +3,29 @@ require 'hashie'
 
 module Rapidash
   module OAuthClient
-
-    attr_accessor :secret, :uid, :access_token, :site, :extension
+    attr_accessor :secret, :uid, :access_token, :site
 
     def initialize(options)
       [:uid, :secret, :site].each do |key|
         if options[key]
           self.send("#{key.to_s}=".to_sym, options[key])
         else
-          raise ConfigurationError.new "Missing #{key} value" 
+          unless self.class.respond_to?(key) && send(key)
+            raise ConfigurationError.new "Missing #{key} value"
+          end
         end
       end
+
       self.access_token = options[:access_token] if options[:access_token]
     end
 
     def request(verb, url, options = {})
-      if extension
-        url = "#{url}.#{(extension)}"
-      elsif self.class.respond_to?(:url_extension) && self.class.url_extension
-        url = "#{url}.#{(self.class.url_extension)}"
-      end
-        options[:raise_errors] = self.class.respond_to?(:raise_error) && self.class.raise_error
+      url = normalize_url(url)
+      options[:body] = options[:body].to_json if options[:body]
+      options[:raise_errors] = self.class.respond_to?(:raise_error) && self.class.raise_error
       response = oauth_access_token.send(verb.to_sym, "#{site}/#{url}", options)
-      return Response.new(response)
+
+      Response.new(response)
     end
 
     def access_token_from_code(code, url)

data/lib/rapidash/resourceable.rb

@@ -1,30 +1,50 @@
 module Rapidash
   module Resourceable
-
     def self.included(base)
       base.extend ClassMethods
     end
 
-    module ClassMethods
+    def resource(name, id = nil, options = {})
+      options[:url] ||= name
+      if self.respond_to?(:url)
+        options = {:previous_url => self.url}.merge!(options)
+      end
+      client = self
+      client = self.client if self.respond_to?(:client)
+      Rapidash::Base.new(client, id, options)
+    end
 
-      def resource(*names)
-        mod = self.to_s.split("::")[0...-1]
-        if mod.empty?
-          mod = Kernel
-        else
-          mod = Kernel.const_get(mod.join("::"))
-        end
+    def resource!(*args)
+      self.resource(*args).call!
+    end
 
 
+    module ClassMethods
+      def resource(*names)
+        options = names.extract_options!
+
+        mod = self.to_s.split("::")[0...-1]
+        mod = mod.empty? ? Object : Object.const_get(mod.join("::"))
 
         names.each do |name|
-          klass = mod.const_get(name.to_s.capitalize)
+          if options[:class_name]
+            class_name = options[:class_name]
+          else
+            class_name = name.to_s.camelcase.singularize
+          end
+
+          begin
+            klass = "#{mod}::#{class_name}".constantize
+          rescue NameError
+            Kernel.warn "[DEPRECATED] - RAPIDASH WARNING using #{class_name.pluralize} instead of #{class_name.singularize} - please either use `#{class_name.singularize}` or set the class name with `resource #{name}, :class_name => #{class_name.pluralize}` implicit plural naming will be deprecated in Rapidash 1.0"
+            klass = "#{mod}::#{class_name}".pluralize.constantize
+          end
 
           define_method(name) do |*args|
             if self.respond_to?(:url)
               options = {:previous_url => self.url}
-              if args[args.length].is_a?(Hash)
-                args[args.length].merge!(options)
+              if args[args.length - 1].is_a?(Hash)
+                args[args.length - 1].merge!(options)
               else
                 args << options
               end
@@ -39,8 +59,6 @@ module Rapidash
           end
         end
       end
-
     end
-
   end
 end