rspec-api 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5408552b4ac63e6bdbbd372c3c900c963f14ffbe
-  data.tar.gz: 53fa90f938352139f11677ae6b414fc32535ea47
+  metadata.gz: a73666993aeb89c6f6d8256fbd334cf95042c055
+  data.tar.gz: b2c4a007b05a4a00427b169dc1bde8440852243b
 SHA512:
-  metadata.gz: 8b86970f33d662320ac5189e82aa1117f1cf44d0ffe583a30c0cae3d4440181769e96cff3cfa7766fd75126d5227423931ffcbc0e3e9801bf123d776bbf53c58
-  data.tar.gz: dddc04c7ced68aa44e82856ce4b73187af7671cc7b6be7b33f1a72ff84f264895356e85542d6eaa3cf6a9974c18b62c2d30c72f8545ef4585b6a4ddd87860429
+  metadata.gz: 172cff78f4cf2cc300fa1e049975cb80604cccc8aa967156d9363b81cee93ee1321e82d1b68f720678f8ec3abd75c48ae95a87aac93d40049ca20675ae46bd7a
+  data.tar.gz: f380e9efcb009d145b5faa83792be55a4e0a6c527026498318fc99702189af5c94612b32099bcd1546a471b6e39a9632206004a4c472f257fccdeb06f6508d6a

data/README.md

@@ -1,2 +1,3 @@
 # RSpec API
 
+More info at [http://rspec-api.github.io](http://rspec-api.github.io)

data/lib/rspec-api/dsl/request/body.rb

@@ -40,8 +40,8 @@ module DSL
 
       def should_be_filtered_by(filter_options)
         it {
-          if json_value = request_params[filter_options[:parameter].to_s]
-            expect(response_body).to be_filtered_by(filter_options[:attribute], json_value)
+          if json_value = request_params[filter_options[:name].to_s]
+            expect(response_body).to be_filtered_by(json_value, filter_options)
           else
             expect(response_body).to be_filtered_by(nil)
           end

data/lib/rspec-api/dsl/resource.rb

@@ -13,6 +13,7 @@ module DSL
 
       define_action :get
       define_action :put
+      define_action :patch
       define_action :post
       define_action :delete
 
@@ -32,7 +33,7 @@ module DSL
 
       # TODO: the second 'accepts_filter' should not override the first, but add
       def accepts_filter(filter_parameter, options={})
-        rspec_api[:filter] = {parameter: filter_parameter, attribute: options[:on]}
+        rspec_api[:filter] = options.merge(name: filter_parameter)
       end
 
     private

data/lib/rspec-api/dsl/{get.rb → route.rb}

@@ -42,15 +42,15 @@ module DSL
         [].tap do |optional_params|
           optional_params << {} # default: no extra params
           if rspec_api[:array]
-            if rspec_api[:sort]
-              optional_params << {sort: rspec_api[:sort][:parameter]}
-              optional_params << {sort: "-#{rspec_api[:sort][:parameter]}"}
+            if sort = rspec_api[:sort]
+              optional_params << {sort: sort[:parameter]}
+              optional_params << {sort: "-#{sort[:parameter]}"}
             end
             if rspec_api[:page]
               optional_params << {page: 2}
             end
-            if rspec_api[:filter]
-              optional_params << {rspec_api[:filter][:parameter] => existing(rspec_api[:filter][:attribute])}
+            if filter = rspec_api[:filter]
+              optional_params << {filter[:name] => existing(filter[:on])}
             end
           end
         end

data/lib/rspec-api/dsl.rb

@@ -1,5 +1,5 @@
 require 'rspec-api/dsl/resource'
-require 'rspec-api/dsl/get'
+require 'rspec-api/dsl/route'
 require 'rspec-api/dsl/request'
 
 module DSL

data/lib/rspec-api/http/local/request.rb

@@ -0,0 +1,15 @@
+module Http
+  module Local
+    module Request
+      extend ActiveSupport::Concern
+
+      def response
+        last_response
+      end
+
+      def request_params
+        last_request.params
+      end
+    end
+  end
+end

data/lib/rspec-api/http/local/route.rb

@@ -0,0 +1,12 @@
+module Http
+  module Local
+    module Route
+      extend ActiveSupport::Concern
+
+      def send_request(verb, route, body)
+        header 'Accept', 'application/json'
+        send verb, route, body
+      end
+    end
+  end
+end

data/lib/rspec-api/http/local.rb

@@ -0,0 +1,11 @@
+require 'rack/test'
+require 'rspec-api/http/local/route'
+require 'rspec-api/http/local/request'
+
+def app
+  Rails.application
+end
+
+RSpec.configuration.include Rack::Test::Methods, rspec_api_dsl: :route
+RSpec.configuration.include Http::Local::Route, rspec_api_dsl: :route
+RSpec.configuration.include Http::Local::Request, rspec_api_dsl: :request

data/lib/rspec-api/http/rack_test.rb

@@ -1,40 +1,11 @@
 require 'rack/test'
+require 'rspec-api/http/local/route'
+require 'rspec-api/http/local/request'
 
 def app
   Rails.application
 end
 
-module DSL
-  module RackTest
-    module Route
-      extend ActiveSupport::Concern
-
-      def send_request(verb, route, body)
-        header 'Accept', 'application/json'
-        send verb, route, body
-      end
-    end
-  end
-end
-
-
-module DSL
-  module RackTest
-    module Request
-      extend ActiveSupport::Concern
-
-      def response
-        last_response
-      end
-
-      def request_params
-        last_request.params
-      end
-    end
-  end
-end
-
-
 RSpec.configuration.include Rack::Test::Methods, rspec_api_dsl: :route
-RSpec.configuration.include DSL::RackTest::Route, rspec_api_dsl: :route
-RSpec.configuration.include DSL::RackTest::Request, rspec_api_dsl: :request
+RSpec.configuration.include Http::Local::Route, rspec_api_dsl: :route
+RSpec.configuration.include Http::Local::Request, rspec_api_dsl: :request

data/lib/rspec-api/http/remote/request.rb

@@ -0,0 +1,15 @@
+module Http
+  module Remote
+    module Request
+      extend ActiveSupport::Concern
+
+      def response
+        @last_response
+      end
+
+      def request_params
+        @last_request.params
+      end
+    end
+  end
+end

data/lib/rspec-api/http/remote/resource.rb

@@ -0,0 +1,13 @@
+module Http
+  module Remote
+    module Resource
+      extend ActiveSupport::Concern
+
+      module ClassMethods
+        def authorize_with(options = {})
+          rspec_api[:authorization] = options
+        end
+      end
+    end
+  end
+end

data/lib/rspec-api/http/remote/route.rb

@@ -0,0 +1,32 @@
+module Http
+  module Remote
+    module Route
+      extend ActiveSupport::Concern
+
+      def send_request(verb, route, body)
+        logger = Logger.new 'log/faraday.log'
+
+        conn = Faraday.new 'https://api.github.com/' do |c| # TODO: Pass host as a parameter
+          # NOTE: The order is **important**! Leave HttpCache first
+          c.use Faraday::HttpCache, store: :file_store, store_options: ['/tmp/faraday'], logger: logger
+          c.use FaradayMiddleware::EncodeJson # query params are not JSON(body) but data are
+          c.use Faraday::Response::Logger, logger
+          c.use Faraday::Adapter::NetHttp
+        end
+
+        conn.headers[:user_agent] = 'RSpec API'
+        conn.authorization *authorization.flatten
+        sleep 0.5 # TODO: Pass as a parameter
+
+        @last_response = conn.send verb, route, body do |request|
+          @last_request = request
+        end
+      end
+
+      def authorization
+        # TODO: Any other way to access metadata in a before(:all) ?
+        self.class.metadata[:rspec_api][:authorization]
+      end
+    end
+  end
+end

data/lib/rspec-api/http/remote.rb

@@ -0,0 +1,23 @@
+require 'faraday'
+require 'faraday_middleware' # TODO: use autoload, we only need EncodeJson
+require 'faraday-http-cache'
+
+# faraday-http-cache is a great gem that correctly ignores Private Cache
+# For the sake of saving Github calls, let's cache Private as well!
+module Faraday
+  class HttpCache
+    class CacheControl
+      def private?
+        false
+      end
+    end
+  end
+end
+
+require 'rspec-api/http/remote/resource'
+require 'rspec-api/http/remote/route'
+require 'rspec-api/http/remote/request'
+
+RSpec.configuration.include Http::Remote::Resource, rspec_api_dsl: :resource
+RSpec.configuration.include Http::Remote::Request, rspec_api_dsl: :request
+RSpec.configuration.include Http::Remote::Route, rspec_api_dsl: :route

data/lib/rspec-api/matchers/filter.rb

@@ -1,9 +1,15 @@
-RSpec::Matchers.define :be_filtered_by do |filtered_attribute, json_value=nil|
+RSpec::Matchers.define :be_filtered_by do |json_value, options = {}|
+  filtered_attribute = options[:on]
+  compare = options[:comparing_with] || Proc.new{|x,y| x == y}
+
   match do |items|
     if filtered_attribute.nil?
       true
     else
-      items.all?{|item| item[filtered_attribute.to_s].to_s == json_value}
+      items.all? do |item|
+        # TODO: Don't always use string
+        compare.call json_value, item[filtered_attribute.to_s].to_s
+      end
     end
   end
 
@@ -11,6 +17,7 @@ RSpec::Matchers.define :be_filtered_by do |filtered_attribute, json_value=nil|
     if filtered_attribute.nil?
       %Q(not be filtered by any specific attribute)
     else
+      # TODO: Change description based on operator
       %Q(be filtered by #{filtered_attribute.to_json} => #{json_value})
     end
   end

data/lib/rspec-api/version.rb

@@ -1,3 +1,3 @@
 module RspecApi
-  VERSION = '0.1.0'
+  VERSION = '0.1.1'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rspec-api
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - claudiob
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-10-08 00:00:00.000000000 Z
+date: 2013-10-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -24,6 +24,34 @@ dependencies:
     - - '>='
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: faraday_middleware
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: faraday-http-cache
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 0.3.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 0.3.0
 description: Helpers to write specs for web APIs
 email:
 - claudiob@gmail.com
@@ -31,15 +59,21 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- lib/rspec-api/active_resource.rb
-- lib/rspec-api/dsl/get.rb
 - lib/rspec-api/dsl/request/body.rb
 - lib/rspec-api/dsl/request/headers.rb
 - lib/rspec-api/dsl/request/status.rb
 - lib/rspec-api/dsl/request.rb
 - lib/rspec-api/dsl/resource.rb
+- lib/rspec-api/dsl/route.rb
 - lib/rspec-api/dsl.rb
+- lib/rspec-api/http/local/request.rb
+- lib/rspec-api/http/local/route.rb
+- lib/rspec-api/http/local.rb
 - lib/rspec-api/http/rack_test.rb
+- lib/rspec-api/http/remote/request.rb
+- lib/rspec-api/http/remote/resource.rb
+- lib/rspec-api/http/remote/route.rb
+- lib/rspec-api/http/remote.rb
 - lib/rspec-api/matchers/attributes.rb
 - lib/rspec-api/matchers/body.rb
 - lib/rspec-api/matchers/content_type.rb

data/lib/rspec-api/active_resource.rb

@@ -1,85 +0,0 @@
-require 'faraday'
-
-module DSL
-  module ActiveResource
-    module Route
-      extend ActiveSupport::Concern
-
-      def send_request(verb, route, body)
-        conn = Faraday.new 'https://api.github.com/' do |c|
-          c.use Faraday::Response::Logger, Logger.new('log/faraday.log')
-          c.use Faraday::Adapter::NetHttp
-        end
-
-        conn.headers[:user_agent] = 'RSpec API for Github'
-        conn.authorization *authorization.flatten
-
-        @last_response = conn.send verb, route, (body.to_json if body.present?)
-      end
-
-      def authorization
-        # TODO: Any other way to access metadata in a before(:all) ?
-        self.class.metadata[:rspec_api][:authorization]
-      end
-
-      module ClassMethods
-
-        def setup_fixtures
-          # nothing to do for now...
-        end
-
-        def existing(field)
-          case field
-          when :user then 'claudiob'
-          when :gist_id then '0d7b597d822102148810'
-          when :id then '921225'
-          end
-        end
-
-        def unknown(field)
-          case field
-          when :user then 'not-a-valid-user'
-          when :gist_id then 'not-a-valid-gist-id'
-          when :id then 'not-a-valid-id'
-          end
-        end
-      end
-    end
-  end
-end
-
-
-module DSL
-  module ActiveResource
-    module Resource
-      extend ActiveSupport::Concern
-
-      module ClassMethods
-        def authorize_with(options = {})
-          rspec_api[:authorization] = options
-        end
-      end
-    end
-  end
-end
-
-
-module DSL
-  module ActiveResource
-    module Request
-      extend ActiveSupport::Concern
-
-      def response
-        @last_response
-      end
-
-      def request_params
-        # TO DO
-      end
-    end
-  end
-end
-
-RSpec.configuration.include DSL::ActiveResource::Resource, rspec_api_dsl: :resource
-RSpec.configuration.include DSL::ActiveResource::Request, rspec_api_dsl: :request
-RSpec.configuration.include DSL::ActiveResource::Route, rspec_api_dsl: :route