bookingsync-api 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: e7a7b6ab1a172640a5ad5e01dca78d0aae5694b8
+  data.tar.gz: a0cfcfe2429857f95e36cf6f3690e3611c88bbb3
+SHA512:
+  metadata.gz: 904395f6a792621c69c12ccfc2059710af400bab9ebc681b3226e3e67d3c9f89cb3c77f31fce52d49e2838c89793e3537164e5bfd372c93f9d762e30a3a0f40e
+  data.tar.gz: efec160c80837d94c52a9aef2aeee9a95f54106a7ea8b73fe43ba9aa517037ac0f7fb85f326861b4b82dd16564322478bfec50a1722751f6e7360b2e620f3e89

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,5 @@
+language: ruby
+rvm:
+  - 2.1.0
+  - 2.0.0
+  - 1.9.3

data/Gemfile

@@ -0,0 +1,14 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in bookingsync-api.gemspec
+
+group 'test' do
+  gem 'rspec', '3.0.0.beta2'
+  gem 'vcr'
+  gem 'webmock'
+  gem 'guard'
+  gem 'guard-rspec'
+  gem 'yard'
+end
+
+gemspec

data/Guardfile

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

data/LICENSE.txt

@@ -0,0 +1,7 @@
+Copyright (c) 2014 Sébastien Grosjean and BookingSync.com
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,47 @@
+[![Build Status](https://travis-ci.org/BookingSync/bookingsync-api.png?branch=master)](https://travis-ci.org/BookingSync/bookingsync-api)
+[![Code Climate](https://codeclimate.com/github/BookingSync/bookingsync-api.png)](https://codeclimate.com/github/BookingSync/bookingsync-api)
+
+# BookingSync::API
+
+This gem allows Ruby developers to programmatically access https://www.bookingsync.com
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'bookingsync-api'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install bookingsync-api
+
+## Usage
+
+Gem assumes that you already have OAuth token for an account.
+
+    api = BookingSync::API.new("OAUTH_TOKEN")
+    rentals = api.rentals # => [Sawyer::Resource, Sawyer::Resource]
+    rentals.first.name # => "Small apartment"
+
+See our [documentation](http://rubydoc.info/github/BookingSync/bookingsync-api) for more info.
+
+## Running specs
+
+    bundle exec rspec
+
+OR
+
+    bundle exec guard
+
+
+## Contributing
+
+1. Fork it ( http://github.com/BookingSync/bookingsync-api/fork )
+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

data/Rakefile

@@ -0,0 +1,4 @@
+require "bundler/gem_tasks"
+require 'rspec/core/rake_task'
+task :default => :spec
+RSpec::Core::RakeTask.new

data/bookingsync-api.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'bookingsync/api/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "bookingsync-api"
+  spec.version       = BookingSync::API::VERSION
+  spec.authors       = ["Sébastien Grosjean"]
+  spec.email         = ["dev@bookingsync.com"]
+  spec.summary       = %q{Ruby interface for accessing https://www.bookingsync.com}
+  spec.description   = %q{This gem allows to interact with the BookingSync API via Ruby objects}
+  spec.homepage      = "https://github.com/BookingSync/bookingsync-api"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "faraday", "~> 0.9"
+  spec.add_dependency "sawyer"
+  spec.add_development_dependency "bundler", "~> 1.5"
+  spec.add_development_dependency "rake"
+end

data/lib/bookingsync/api.rb

@@ -0,0 +1,17 @@
+require "faraday"
+require "sawyer"
+
+require "bookingsync/api/version"
+require "bookingsync/api/client"
+
+module BookingSync
+  module API
+    # Return new API Client
+    #
+    # @param token [String] OAuth token
+    # @return [BookingSync::API::Client] New BookingSync API client
+    def self.new(token)
+      Client.new(token)
+    end
+  end
+end

data/lib/bookingsync/api/client.rb

@@ -0,0 +1,106 @@
+require "bookingsync/api/middleware/authentication"
+require "bookingsync/api/client/bookings"
+require "bookingsync/api/client/rentals"
+require "bookingsync/api/error"
+
+module BookingSync::API
+  class Client
+    include BookingSync::API::Client::Bookings
+    include BookingSync::API::Client::Rentals
+
+    MEDIA_TYPE = "application/vnd.api+json"
+
+    attr_reader :token
+
+    # Initialize new Client
+    #
+    # @param token [String] OAuth token
+    # @return [BookingSync::API::Client] New BookingSync API client
+    def initialize(token)
+      @token = token
+    end
+
+    # Make a HTTP GET request
+    #
+    # @param path [String] The path, relative to {#api_endpoint}
+    # @return [Array<Sawyer::Resource>] Array of resources.
+    def get(path, options = {})
+      request :get, path, options
+    end
+
+    # Return API endpoint
+    #
+    # @return [String] URL to API endpoint
+    def api_endpoint
+      "#{base_url}/api/v3"
+    end
+
+    protected
+
+    # Make a HTTP request to given path
+    #
+    # @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.
+    # @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}
+      end
+
+      response = agent.call(method, path, nil, request_options)
+      case response.status
+      # fetch objects from outer hash
+      # {rentals => [{rental}, {rental}]}
+      # will return [{rental}, {rental}]
+      when 200..299; response.data.to_hash.values.flatten
+      when 401; raise Unauthorized.new
+      end
+    end
+
+    private
+
+    def agent
+      @agent ||= Sawyer::Agent.new(api_endpoint, sawyer_options) do |http|
+        http.headers[:accept] = MEDIA_TYPE
+      end
+    end
+
+    def middleware
+      Faraday::RackBuilder.new do |builder|
+        builder.use :authentication, token
+        builder.adapter Faraday.default_adapter
+      end
+    end
+
+    def sawyer_options
+      {faraday: Faraday.new(faraday_options)}
+    end
+
+    def faraday_options
+      {builder: middleware, ssl: {verify: verify_ssl?}}
+    end
+
+    # Return BookingSync base URL. Default is https://www.bookingsync.com
+    # it can be altered via ENV variable BOOKINGSYNC_URL which
+    # is useful in specs when recording vcr cassettes
+    #
+    # @return [String] Base URL to BookingSync
+    def base_url
+      ENV.fetch "BOOKINGSYNC_URL", "https://www.bookingsync.com"
+    end
+
+    # Return true if SSL cert should be verified
+    # By default is true, can be changed to false using
+    # env variable VERIFY_SSL
+    #
+    # @return [Boolean] true if SSL needs to be verified
+    # false otherwise
+    def verify_ssl?
+      ENV["BOOKINGSYNC_VERIFY_SSL"] == "false" ? false : true
+    end
+  end
+end

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

@@ -0,0 +1,16 @@
+module BookingSync::API
+  class Client
+    module Bookings
+      # List bookings
+      #
+      # Return public future bookings for the account user
+      # is authenticated with.
+      # @param options [Hash] A customizable set of options.
+      # @option options [Array] fields: List of fields to be fetched.
+      # @return [Array<Sawyer::Resource>] Array of bookings.
+      def bookings(options = {})
+        get :bookings, options
+      end
+    end
+  end
+end

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

@@ -0,0 +1,21 @@
+module BookingSync::API
+  class Client
+    module Rentals
+      # List rentals
+      #
+      # Returns rentals for the account user is authenticated with.
+      # @param options [Hash] A customizable set of options.
+      # @option options [Array] fields: List of fields to be fetched.
+      # @return [Array<Sawyer::Resource>] Array of rentals.
+      #
+      # @example Get the list of rentals for the current account
+      #   rentals = @api.rentals
+      #   rentals.first.name # => "Small apartment"
+      # @example Get the list of rentals only with name and description for smaller response
+      #   @api.rentals(fields: [:name, :description])
+      def rentals(options = {})
+        get :rentals, options
+      end
+    end
+  end
+end

data/lib/bookingsync/api/error.rb

@@ -0,0 +1,5 @@
+module BookingSync::API
+  # Class for rescuing all BS API errors
+  class Error < StandardError; end
+  class Unauthorized < Error; end
+end

data/lib/bookingsync/api/middleware/authentication.rb

@@ -0,0 +1,18 @@
+module BookingSync::API::Middleware
+  # Provides faraday middleware for authentication using OAuth token
+  # We don't use default FaradayMiddleware::OAuth2 because
+  # it adds access_token param to the URL
+  class Authentication < Faraday::Middleware
+    def initialize(app, token)
+      @app = app
+      @token = token
+    end
+
+    def call(env)
+      env[:request_headers]["Authorization"] = "Bearer #{@token}"
+      @app.call(env)
+    end
+  end
+
+  Faraday::Middleware.register_middleware authentication: Authentication
+end

data/lib/bookingsync/api/version.rb

@@ -0,0 +1,5 @@
+module BookingSync
+  module API
+    VERSION = "0.0.1"
+  end
+end

data/spec/bookingsync/api/client/bookings_spec.rb

@@ -0,0 +1,12 @@
+require "spec_helper"
+
+describe BookingSync::API::Client::Bookings do
+  let(:client) { BookingSync::API::Client.new(test_access_token) }
+
+  describe ".bookings", :vcr do
+    it "returns bookings" do
+      expect(client.bookings).not_to be_nil
+      assert_requested :get, bs_url("bookings")
+    end
+  end
+end

data/spec/bookingsync/api/client/rentals_spec.rb

@@ -0,0 +1,20 @@
+require "spec_helper"
+
+describe BookingSync::API::Client::Rentals do
+  let(:client) { BookingSync::API::Client.new(test_access_token) }
+
+  describe ".rentals", :vcr do
+    it "returns rentals" do
+      expect(client.rentals).not_to be_nil
+      assert_requested :get, bs_url("rentals")
+    end
+
+    context "with specified fields in options" do
+      it "returns rentals with filtered fields" do
+        rentals = client.rentals(fields: :name)
+        expect(rentals).not_to be_nil
+        assert_requested :get, bs_url("rentals?fields=name")
+      end
+    end
+  end
+end

data/spec/bookingsync/api/client_spec.rb

@@ -0,0 +1,84 @@
+require "spec_helper"
+
+describe BookingSync::API::Client do
+  let(:client) { BookingSync::API::Client.new(test_access_token) }
+
+  describe "#new" do
+    it "initializes client object with given token" do
+      client = BookingSync::API::Client.new("xyz")
+      expect(client.token).to eql("xyz")
+    end
+  end
+
+  describe "#get" do
+    before { VCR.turn_off! }
+    it "makes a HTTP GET request" do
+      stub_get("resource")
+      client.get("resource")
+      assert_requested :get, bs_url("resource")
+    end
+  end
+
+  describe "#request" do
+    before { VCR.turn_off! }
+    it "authenticates the request with OAuth token" do
+      ENV["ACCESS_TOKEN"] = nil
+      stub_get("resource")
+      client.get("resource")
+      assert_requested :get, bs_url("resource"),
+        headers: {"Authorization" => "Bearer fake-access-token"}
+    end
+
+    it "requests proper content type for JSON API" do
+      stub_get("resource")
+      client.get("resource")
+      assert_requested :get, bs_url("resource"),
+        headers: {"Accept" => "application/vnd.api+json"}
+    end
+
+    it "returns Array of resources" do
+      stub_get("resource", body: {resources: [{name: "Megan"}]}.to_json)
+      resources = client.get("resource")
+      expect(resources.size).to eq(1)
+      expect(resources.first.name).to eq("Megan")
+    end
+
+    context "client returns 401" do
+      it "raises Unauthorized exception" do
+        stub_get("resource", status: 401)
+        expect {
+          client.get("resource")
+        }.to raise_error(BookingSync::API::Unauthorized)
+      end
+    end
+
+    context "status code is outside 200..299 range" do
+      it "returns nil" do
+        stub_get("resource", status: 404)
+        expect(client.get("resource")).to be_nil
+      end
+    end
+
+    context "user wants to fetch only specific fields" do
+      it "constructs url for filtered fields" do
+        stub_get("resource?fields=name,description")
+        client.get("resource", fields: [:name, :description])
+        assert_requested :get, bs_url("resource?fields=name,description")
+      end
+    end
+  end
+
+  describe "#api_endpoint" do
+    it "returns URL to the API" do
+      ENV["BOOKINGSYNC_URL"] = nil
+      expect(client.api_endpoint).to eql("https://www.bookingsync.com/api/v3")
+    end
+
+    context "user specifies base URL via BOOKINGSYNC_URL env" do
+      it "returns custom URL to the API" do
+        ENV["BOOKINGSYNC_URL"] = "https://bookingsync.dev"
+        expect(client.api_endpoint).to eql("https://bookingsync.dev/api/v3")
+      end
+    end
+  end
+end

data/spec/bookingsync/api_spec.rb

@@ -0,0 +1,14 @@
+require "spec_helper"
+
+describe BookingSync::API do
+  it "should have a version number" do
+    expect(BookingSync::API::VERSION).not_to be_nil
+  end
+
+  describe ".new" do
+    it "returns a new Client" do
+      client = BookingSync::API.new("token")
+      expect(client).to be_kind_of(BookingSync::API::Client)
+    end
+  end
+end

data/spec/cassettes/BookingSync_API_Client_Bookings/_bookings/returns_bookings.yml

@@ -0,0 +1,57 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: https://www.bookingsync.com/api/v3/bookings
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      User-Agent:
+      - Faraday v0.9.0
+      Accept:
+      - application/vnd.api+json
+      Authorization:
+      - Bearer <<ACCESS_TOKEN>>
+      Accept-Encoding:
+      - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      X-Ratelimit-Limit:
+      - '1000'
+      X-Ratelimit-Reset:
+      - '1394193600'
+      X-Ratelimit-Remaining:
+      - '995'
+      Access-Control-Allow-Origin:
+      - "*"
+      Access-Control-Request-Method:
+      - "*"
+      Content-Type:
+      - application/vnd.api+json; charset=utf-8
+      X-Ua-Compatible:
+      - IE=Edge
+      Etag:
+      - "\"435e6e3ac9649b612515cf4bc58d6643\""
+      Cache-Control:
+      - max-age=0, private, must-revalidate
+      P3p:
+      - CP="OTI DSP COR CUR ADMo DEVo TAI PSAi PSDi IVAi IVDi CONi HISi TELi OTPi
+        OUR SAMi OTRo UNRo PUBi IND UNI STA"
+      X-Request-Id:
+      - 8ceb28412ce6b54c63adfeb683e05ad3
+      X-Runtime:
+      - '0.161117'
+      Date:
+      - Fri, 07 Mar 2014 11:28:17 GMT
+      Connection:
+      - close
+    body:
+      encoding: UTF-8
+      string: "{\"bookings\":[{\"id\":1,\"account_id\":1,\"rental_id\":2,\"start_at\":\"2014-04-28T10:55:13Z\",\"end_at\":\"2014-12-28T10:55:34Z\"},{\"id\":4,\"account_id\":1,\"rental_id\":2,\"start_at\":\"2014-04-28T10:55:13Z\",\"end_at\":\"2014-12-28T10:55:34Z\"}]}"
+    http_version:
+  recorded_at: Fri, 07 Mar 2014 11:28:17 GMT
+recorded_with: VCR 2.8.0

data/spec/cassettes/BookingSync_API_Client_Rentals/_rentals/returns_rentals.yml

@@ -0,0 +1,66 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: https://www.bookingsync.com/api/v3/rentals
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      User-Agent:
+      - Faraday v0.8.9
+      Accept:
+      - application/vnd.api+json
+      Authorization:
+      - Bearer <<ACCESS_TOKEN>>
+      Accept-Encoding:
+      - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      X-Ratelimit-Limit:
+      - '1000'
+      X-Ratelimit-Reset:
+      - '1393963200'
+      X-Ratelimit-Remaining:
+      - '998'
+      Access-Control-Allow-Origin:
+      - "*"
+      Access-Control-Request-Method:
+      - "*"
+      Content-Type:
+      - application/vnd.api+json; charset=utf-8
+      X-Ua-Compatible:
+      - IE=Edge
+      Etag:
+      - "\"ddf4735a349a4822af7cc71fa3cf5869\""
+      Cache-Control:
+      - max-age=0, private, must-revalidate
+      P3p:
+      - CP="OTI DSP COR CUR ADMo DEVo TAI PSAi PSDi IVAi IVDi CONi HISi TELi OTPi
+        OUR SAMi OTRo UNRo PUBi IND UNI STA"
+      X-Request-Id:
+      - a7d144d12012bb2652e2f421b301ea3a
+      X-Runtime:
+      - '0.183894'
+      Date:
+      - Tue, 04 Mar 2014 19:55:10 GMT
+      Connection:
+      - close
+    body:
+      encoding: UTF-8
+      string: "{\"rentals\":[{\"links\":{\"photos\":[]},\"account_id\":1,\"id\":2,\"name\":\"0
+        est\",\"headline\":{\"en\":\"Super Headline\"},\"summary\":{\"en\":\"Super
+        summary\"},\"description\":{\"en\":\"Complete description\"},\"rental_type\":\"villa\",\"units\":1,\"bedrooms\":null,\"sleeps\":7,\"sleeps_max\":null,\"bathrooms\":3,\"surface\":120,\"bookable_online\":false,\"min_price\":700,\"max_price\":700,\"price_kind\":\"weekly\",\"currency\":\"EUR\",\"rates_public_notes\":{\"en\":null},\"lat\":45.02,\"lng\":6.6,\"city\":\"Nevache\",\"state\":null,\"country\":\"France\",\"contact_name\":\"Contact
+        Fullname\",\"amenities\":[],\"reviews_count\":0,\"reviews_average_rating\":null,\"updated_at\":\"2014-02-11T09:13:20Z\"},{\"links\":{\"photos\":[2]},\"account_id\":1,\"id\":4,\"name\":\"1
+        et\",\"headline\":{\"en\":\"Super Headline\"},\"summary\":{\"en\":\"Super
+        summary\"},\"description\":{\"en\":\"Complete description\"},\"rental_type\":\"villa\",\"units\":1,\"bedrooms\":null,\"sleeps\":7,\"sleeps_max\":null,\"bathrooms\":3,\"surface\":120,\"bookable_online\":false,\"min_price\":700,\"max_price\":700,\"price_kind\":\"weekly\",\"currency\":\"EUR\",\"rates_public_notes\":{\"en\":null},\"lat\":45.02,\"lng\":6.6,\"city\":\"Nevache\",\"state\":null,\"country\":\"France\",\"contact_name\":\"Contact
+        Fullname\",\"amenities\":[],\"reviews_count\":0,\"reviews_average_rating\":null,\"updated_at\":\"2014-02-11T09:13:25Z\"},{\"links\":{\"photos\":[]},\"account_id\":1,\"id\":6,\"name\":\"2
+        officiis\",\"headline\":{\"en\":\"Super Headline\"},\"summary\":{\"en\":\"Super
+        summary\"},\"description\":{\"en\":\"Complete description\"},\"rental_type\":\"villa\",\"units\":1,\"bedrooms\":null,\"sleeps\":7,\"sleeps_max\":null,\"bathrooms\":3,\"surface\":120,\"bookable_online\":false,\"min_price\":700,\"max_price\":700,\"price_kind\":\"weekly\",\"currency\":\"EUR\",\"rates_public_notes\":{\"en\":null},\"lat\":45.02,\"lng\":6.6,\"city\":\"Nevache\",\"state\":null,\"country\":\"France\",\"contact_name\":\"Contact
+        Fullname\",\"amenities\":[],\"reviews_count\":0,\"reviews_average_rating\":null,\"updated_at\":\"2014-02-28T11:00:58Z\"}]}"
+    http_version:
+  recorded_at: Tue, 04 Mar 2014 19:55:10 GMT
+recorded_with: VCR 2.8.0

data/spec/cassettes/BookingSync_API_Client_Rentals/_rentals/with_specified_fields_in_options/returns_rentals_with_filtered_fields.yml

@@ -0,0 +1,57 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: https://www.bookingsync.com/api/v3/rentals?fields=name
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      User-Agent:
+      - Faraday v0.9.0
+      Accept:
+      - application/vnd.api+json
+      Authorization:
+      - Bearer <<ACCESS_TOKEN>>
+      Accept-Encoding:
+      - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      X-Ratelimit-Limit:
+      - '1000'
+      X-Ratelimit-Reset:
+      - '1394208000'
+      X-Ratelimit-Remaining:
+      - '991'
+      Access-Control-Allow-Origin:
+      - "*"
+      Access-Control-Request-Method:
+      - "*"
+      Content-Type:
+      - application/vnd.api+json; charset=utf-8
+      X-Ua-Compatible:
+      - IE=Edge
+      Etag:
+      - "\"8bd58448e878aa40ad4737a54ea875a1\""
+      Cache-Control:
+      - max-age=0, private, must-revalidate
+      P3p:
+      - CP="OTI DSP COR CUR ADMo DEVo TAI PSAi PSDi IVAi IVDi CONi HISi TELi OTPi
+        OUR SAMi OTRo UNRo PUBi IND UNI STA"
+      X-Request-Id:
+      - d307cea3bd765e0d109b268f8fa8fe3c
+      X-Runtime:
+      - '0.021144'
+      Date:
+      - Fri, 07 Mar 2014 15:38:45 GMT
+      Connection:
+      - close
+    body:
+      encoding: UTF-8
+      string: "{\"rentals\":[{\"name\":\"0 est\"},{\"name\":\"1 et\"}]}"
+    http_version:
+  recorded_at: Fri, 07 Mar 2014 15:38:45 GMT
+recorded_with: VCR 2.8.0

data/spec/spec_helper.rb

@@ -0,0 +1,40 @@
+$LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
+require 'bookingsync/api'
+require 'webmock/rspec'
+require 'vcr'
+require 'json'
+
+RSpec.configure do |config|
+  config.before do
+    ENV["BOOKINGSYNC_VERIFY_SSL"] = "false"
+  end
+  config.include WebMock::API
+end
+
+VCR.configure do |c|
+  c.cassette_library_dir = "spec/cassettes"
+  c.hook_into :webmock
+  c.configure_rspec_metadata!
+  c.filter_sensitive_data("<<ACCESS_TOKEN>>") do
+    test_access_token
+  end
+  c.default_cassette_options = {match_requests_on: [:method, :path]}
+end
+
+def test_access_token
+  ENV.fetch "ACCESS_TOKEN", "fake-access-token"
+end
+
+def bs_url(path = "")
+  # so that it works when running against local BS API
+  url = ENV['BOOKINGSYNC_URL'] || 'https://www.bookingsync.com'
+  "#{url}/api/v3/#{path}"
+end
+
+def stub_get(path, options = {})
+  response = {
+    body: {}.to_json,
+    headers: {"Content-Type" => "application/vnd.api+json"}
+  }.merge(options)
+  stub_request(:get, bs_url(path)).to_return(response)
+end

metadata

@@ -0,0 +1,133 @@
+--- !ruby/object:Gem::Specification
+name: bookingsync-api
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Sébastien Grosjean
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-03-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+- !ruby/object:Gem::Dependency
+  name: sawyer
+  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: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: This gem allows to interact with the BookingSync API via Ruby objects
+email:
+- dev@bookingsync.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- Guardfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bookingsync-api.gemspec
+- lib/bookingsync/api.rb
+- lib/bookingsync/api/client.rb
+- lib/bookingsync/api/client/bookings.rb
+- lib/bookingsync/api/client/rentals.rb
+- lib/bookingsync/api/error.rb
+- lib/bookingsync/api/middleware/authentication.rb
+- lib/bookingsync/api/version.rb
+- spec/bookingsync/api/client/bookings_spec.rb
+- spec/bookingsync/api/client/rentals_spec.rb
+- spec/bookingsync/api/client_spec.rb
+- spec/bookingsync/api_spec.rb
+- spec/cassettes/BookingSync_API_Client_Bookings/_bookings/returns_bookings.yml
+- spec/cassettes/BookingSync_API_Client_Rentals/_rentals/returns_rentals.yml
+- spec/cassettes/BookingSync_API_Client_Rentals/_rentals/with_specified_fields_in_options/returns_rentals_with_filtered_fields.yml
+- spec/spec_helper.rb
+homepage: https://github.com/BookingSync/bookingsync-api
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.0
+signing_key: 
+specification_version: 4
+summary: Ruby interface for accessing https://www.bookingsync.com
+test_files:
+- spec/bookingsync/api/client/bookings_spec.rb
+- spec/bookingsync/api/client/rentals_spec.rb
+- spec/bookingsync/api/client_spec.rb
+- spec/bookingsync/api_spec.rb
+- spec/cassettes/BookingSync_API_Client_Bookings/_bookings/returns_bookings.yml
+- spec/cassettes/BookingSync_API_Client_Rentals/_rentals/returns_rentals.yml
+- spec/cassettes/BookingSync_API_Client_Rentals/_rentals/with_specified_fields_in_options/returns_rentals_with_filtered_fields.yml
+- spec/spec_helper.rb
+has_rdoc: