bookingsync-api 0.0.3 → 0.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e9feafbe1659c58b2d4914234364c5f19e7e56a2
-  data.tar.gz: b10ca8cf51d587cdca7704e36680e92a36ba7c1c
+  metadata.gz: 482e5a2b0789e895be5b708da4e0695d9f0a260f
+  data.tar.gz: 9243586b0e24bbab147f20ecbce0b6da009de350
 SHA512:
-  metadata.gz: feefb5721a6bbf3874302873de4e7efa2f63ab31880674c61122fad6c4dceca87e53ed42f1545595a936042b0ef72dc2a5bd8302799d132fffda0a697713e422
-  data.tar.gz: aa7419b2ad612b546f71fc36e1b0098284a0c1dc503c2d4a78749e7cdef96bfb8180c31bfcbb0ace7b1168661089fdb3074cdd0d0134765465d7b99a3d69206f
+  metadata.gz: 366e4825396ef6b9cfcb2596c4ac9fdab053c8b8ce0a82ecfc7c16817724b3995df63eddc5e6e386ce077188b2286f3828fbd5a23875f5f5c82035376a1f4312
+  data.tar.gz: ae0492b2ab4c56881ba3c225357cd72fd24d981ca94f2e6d602f1236d8914a1e4c0a65e61cfba93efe9312565ac7ebf0eb15d6be2059a4d28e4e3c4e4e72f939

data/Gemfile

@@ -9,6 +9,7 @@ group 'test' do
   gem 'guard'
   gem 'guard-rspec'
   gem 'yard'
+  gem 'guard-yard'
 end
 
 gemspec

data/Guardfile

@@ -4,3 +4,7 @@ guard :rspec do
   watch(%r{^lib/bookingsync/api/(.+)\.rb$})         { |m| "spec/bookingsync/api/#{m[1]}_spec.rb" }
   watch('spec/spec_helper.rb')  { "spec" }
 end
+
+guard 'yard' do
+  watch(%r{lib/.+\.rb})
+end

data/lib/bookingsync/api/client.rb

@@ -41,17 +41,14 @@ module BookingSync::API
     #
     # @param method [Symbol] HTTP verb to use.
     # @param path [String] The path, relative to {#api_endpoint}.
-    # @param options [Hash] A customizable set of options.
-    # @option options [Array] fields: List of fields to be fetched.
+    # @param query [Hash] A customizable set of query options.
     # @return [Array<Sawyer::Resource>] Array of resources.
-    def request(method, path, options = {})
-      request_options = {}
-      if options.has_key?(:fields)
-        fields = Array(options[:fields]).join(",")
-        request_options[:query] = {fields: fields}
+    def request(method, path, query = {})
+      [:fields, :status].each do |key|
+        query[key] = Array(query[key]).join(",") if query.has_key?(key)
       end
 
-      response = agent.call(method, path, nil, request_options)
+      response = agent.call(method, path, nil, {query: query})
       case response.status
       # fetch objects from outer hash
       # {rentals => [{rental}, {rental}]}

data/lib/bookingsync/api/client/bookings.rb

@@ -5,9 +5,19 @@ module BookingSync::API
       #
       # Return public future bookings for the account user
       # is authenticated with.
-      # @param options [Hash] A customizable set of options.
+      # @param options [Hash] A customizable set of query options.
       # @option options [Array] fields: List of fields to be fetched.
+      # @option options [Time] from: Select bookings ending after given date.
+      # @option options [Time] until: Select bookings starting before given date.
+      # @option options [Integer] months: Select bookings starting before
+      #   :from + months, if :from is blank, current time is taken.
+      # @option options [Boolean] include_canceled: If true canceled bookings
+      #   are shown, otherwise they are hidden.
+      # @option options [Array] status: Array of booking states.
+      #   If specyfied bookings with given states are shown.
       # @return [Array<Sawyer::Resource>] Array of bookings.
+      # @example
+      #   @api.bookings(months: 12, states: [:booked, :unavailable], include_canceled: true)
       def bookings(options = {})
         get :bookings, options
       end

data/lib/bookingsync/api/version.rb

@@ -1,5 +1,5 @@
 module BookingSync
   module API
-    VERSION = "0.0.3"
+    VERSION = "0.0.4"
   end
 end

data/spec/bookingsync/api/client_spec.rb

@@ -66,6 +66,14 @@ describe BookingSync::API::Client do
         assert_requested :get, bs_url("resource?fields=name,description")
       end
     end
+
+    context "user passes additional query options" do
+      it "constructs url with query options" do
+        stub_get("resource?months=12&status=booked,unavailable")
+        client.get("resource", status: [:booked, :unavailable], months: '12')
+        assert_requested :get, bs_url("resource?months=12&status=booked,unavailable")
+      end
+    end
   end
 
   describe "#api_endpoint" do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: bookingsync-api
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
 platform: ruby
 authors:
 - Sébastien Grosjean
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-03-12 00:00:00.000000000 Z
+date: 2014-03-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday