airbnb_api 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 0d99109e63b4a91df5ab728034eceb9267442709
-  data.tar.gz: 67da1aed62d058c5b3cadeed7d7e0e9014f4eee3
+SHA256:
+  metadata.gz: 4ec168f185260189dcf64ac1d372f4031462317d2426b32f2818640de90d22bc
+  data.tar.gz: 2cf16056ff63550ab17dfe57727af0cb414006507553153edbfd1d421be047af
 SHA512:
-  metadata.gz: 46be1eda9036108d6db2af598eb9454fd60e141b60992c813d2949ec8c971422c46917a9bc4d3b301e245359f7db84914c04646f6d247911ed5fff67e023b5e7
-  data.tar.gz: ab2a5dd8ab0fff2f628736385e3780fb429bd26a6114ad77a5a514e9828d575299ad8b1b195eacd1c5a9cc6effcba0f50c3381ec11980b462ad0729c022c21f3
+  metadata.gz: afcf74f219b732ee6e4dece2258a13982fbb74bb8f59ad7cb5e55ebe5d7c79a9cb5ca4fec9daa6dcb25b8fb70c75543de26e8ed498b2014efadf3cd864479276
+  data.tar.gz: d0e813ae95489dac63bae440d3ca895baef572eff97359546145cadab46256572d3814e6e743ae082f8b19e6b943944caec78e4934369b16be93c7b2cd804768

data/.gitignore

@@ -7,3 +7,4 @@
 /pkg/
 /spec/reports/
 /tmp/
+/airbnb_api-*.gem

data/.travis.yml

@@ -2,3 +2,14 @@ sudo: false
 language: ruby
 rvm:
   - 2.2.4
+env:
+  global:
+    - CC_TEST_REPORTER_ID=45175f9e10f6665368de72e4049a8c258ac65dacd4704f8cf1e71a5a87835498
+
+before_script:
+  - curl -L https://codeclimate.com/downloads/test-reporter/test-reporter-latest-linux-amd64 > ./cc-test-reporter
+  - chmod +x ./cc-test-reporter
+  - ./cc-test-reporter before-build
+
+after_script:
+  - ./cc-test-reporter after-build --exit-code $TRAVIS_TEST_RESULT

data/README.md

@@ -1,6 +1,8 @@
 # AirbnbApi
 
-Simple gem to use the Airbnb API. Still work in progress since the Airbnb API is still work in progress.
+[![Build Status](https://travis-ci.org/dennisvdvliet/airbnb_api.svg?branch=master)](https://travis-ci.org/dennisvdvliet/airbnb_api) [![Maintainability](https://api.codeclimate.com/v1/badges/616582587775bcabe3cd/maintainability)](https://codeclimate.com/github/dennisvdvliet/airbnb_api/maintainability) [![Test Coverage](https://api.codeclimate.com/v1/badges/616582587775bcabe3cd/test_coverage)](https://codeclimate.com/github/dennisvdvliet/airbnb_api/test_coverage) [![Gem Version](https://badge.fury.io/rb/airbnb_api.svg)](https://badge.fury.io/rb/airbnb_api)
+
+The AirbnbApi ruby library provides an easy way to interact with the Airbnb API. The Airbnb API is being actively developed so please expect this gem to change regularly. The documentation for the Airbnb API can be found [here](https://www.airbnb.com/partner/api-docs/).
 
 ## Installation
 
@@ -20,7 +22,37 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+### Authorization
+
+Some endpoints on the Airbnb API can be accessed using the Client ID and Client Secret you obtain by registering your application with Airbnb. However the majority of endpoints require and oAuth token you get from the end user.
+
+To obtain an oAuth token redirect a user to the following url:
+```
+https://www.airbnb.com/oauth2/auth?client_id=:your_client_id&redirect_uri=:your_redirect_url&scope=:your_scope&state=:whatever_you_want
+```
+
+One the user logged in and approved your application they will be redirected to `:your_redirect_url`. This redirect request will include two additional GET parameters: `code` and `scope`
+
+In case the user does not approve your application the same URL will be used but the followin GET parameters will be included: `error` and `error_description`
+
+The `code` can be used to obtain an `access_token` and a `refresh_token` you can use to perform API requests. You can use the following code to get them.
+
+```ruby
+client = AirbnbApi::Client.new(id: '1234', secret: 'topsecret')
+tokens = client.tokens.create_from_code(code)
+```
+
+You save both the `access_token` and `refresh_token` since you will need the `refresh_token` to obtain a new `access_token` once it expires. Currently the `access_token` expires after 24 hours.
+
+Refreshing a token is done as follows:
+
+```ruby
+tokens = client.tokens.refresh_token(refresh_token)
+```
+
+
+
+## Supported endpoints
 
 ## Development
 
@@ -30,7 +62,7 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/airbnb_api. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+Bug reports and pull requests are welcome on GitHub at https://github.com/dennisvdvliet/airbnb_api. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
 
 
 ## License

data/Rakefile

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

data/airbnb_api.gemspec

@@ -1,30 +1,30 @@
-# coding: utf-8
+
 lib = File.expand_path('../lib', __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'airbnb_api/version'
 
 Gem::Specification.new do |spec|
-  spec.name          = "airbnb_api"
+  spec.name          = 'airbnb_api'
   spec.version       = AirbnbApi::VERSION
-  spec.authors       = ["Dennis van der Vliet"]
-  spec.email         = ["dennis.vandervliet@gmail.com"]
+  spec.authors       = ['Dennis van der Vliet']
+  spec.email         = ['dennis.vandervliet@gmail.com']
 
-  spec.summary       = "API Client for Airbnb API"
-  spec.description   = "API Client for Airbnb API"
-  spec.homepage      = "https://github.com/dennisvdvliet/airbnb_api"
-  spec.license       = "MIT"
+  spec.summary       = 'API Client for Airbnb API'
+  spec.description   = 'API Client for Airbnb API'
+  spec.homepage      = 'https://github.com/dennisvdvliet/airbnb_api'
+  spec.license       = 'MIT'
 
   spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
-  spec.bindir        = "exe"
+  spec.bindir        = 'exe'
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
-  spec.require_paths = ["lib"]
-
-  spec.add_dependency "faraday"
-  spec.add_dependency "faraday_middleware"
+  spec.require_paths = ['lib']
 
-  spec.add_development_dependency "bundler", "~> 1.12"
-  spec.add_development_dependency "rake", "~> 10.0"
-  spec.add_development_dependency "rspec", "~> 3.0"
-  spec.add_development_dependency "webmock", "~> 3.1"
+  spec.add_dependency 'faraday'
+  spec.add_dependency 'faraday_middleware'
 
+  spec.add_development_dependency 'bundler', '~> 1.12'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'simplecov'
+  spec.add_development_dependency 'webmock', '~> 3.1'
 end

data/bin/console

@@ -1,7 +1,7 @@
 #!/usr/bin/env ruby
 
-require "bundler/setup"
-require "airbnb_api"
+require 'bundler/setup'
+require 'airbnb_api'
 
 # You can add fixtures and/or initialization code here to make experimenting
 # with your gem easier. You can also use a different console, if you like.
@@ -10,5 +10,5 @@ require "airbnb_api"
 # require "pry"
 # Pry.start
 
-require "irb"
+require 'irb'
 IRB.start

data/lib/airbnb_api.rb

@@ -1,9 +1,22 @@
 require 'faraday'
 require 'faraday_middleware'
+require 'json'
 
+# api operations
+require 'airbnb_api/api_operations/find'
+require 'airbnb_api/api_operations/create'
 
-require "airbnb_api/version"
-require "airbnb_api/client"
-module AirbnbApi
-  # Your code goes here...
-end
+require 'airbnb_api/version'
+
+require 'airbnb_api/client'
+
+require 'airbnb_api/service'
+require 'airbnb_api/service/listing'
+require 'airbnb_api/service/token'
+
+require 'airbnb_api/resource'
+require 'airbnb_api/resource/listing'
+require 'airbnb_api/resource/token'
+
+require 'airbnb_api/errors/errors'
+require 'airbnb_api/util/error_handling'

data/lib/airbnb_api/api_operations/create.rb

@@ -0,0 +1,9 @@
+module AirbnbApi
+  module APIOperations
+    module Create
+      def create(attributes)
+        build @client.post(self.class.path.to_s, attributes.to_json)
+      end
+    end
+  end
+end

data/lib/airbnb_api/api_operations/find.rb

@@ -0,0 +1,9 @@
+module AirbnbApi
+  module APIOperations
+    module Find
+      def find(id)
+        @client.get("#{self.class.path}/#{id}")
+      end
+    end
+  end
+end

data/lib/airbnb_api/client.rb

@@ -2,9 +2,11 @@ require 'base64'
 
 module AirbnbApi
   class Client
-    attr_reader :id, :secret
-    def initialize(id: ,secret:)
-      @id, @secret = id, secret
+    attr_reader :id, :secret, :oauth_token
+    def initialize(id:, secret:, oauth_token: nil)
+      @id = id
+      @secret = secret
+      @oauth_token = oauth_token
     end
 
     def version
@@ -12,38 +14,59 @@ module AirbnbApi
     end
 
     def base_url
-      "https://api.airbnb.com"
+      'https://api.airbnb.com'
     end
 
     def adapter
       @adapter ||= Faraday.default_adapter
     end
 
-
     def http
       @http ||= Faraday.new(url: base_url) do |faraday|
         faraday.headers = headers
         faraday.request :url_encoded
         faraday.response :json
+
+        faraday.use AirbnbApi::Util::ErrorHandling
+
         faraday.adapter adapter
       end
     end
 
     %i[get patch post delete].each do |call|
       define_method call do |path, options = {}|
-        http.public_send(call, "/#{version}/#{path}", options).body
+        http.public_send(call, "#{version}#{path}", options).body
       end
     end
 
+    def oauth_token?
+      @oauth_token != nil
+    end
+
+    def listings
+      AirbnbApi::Service::Listing.new(self)
+    end
+
+    def tokens
+      return AirbnbApi::Service::Token.new(self) if AirbnbApi::Service::Token.can_use_client?(self)
+      raise AirbnbApi::Errors::InvalidClient
+    end
 
     private
 
     def headers
-      {
+      default = {
         'Accept' => 'application/json',
-        'Content-Type' => 'application/json',
-        'Authorization' => "Basic #{basic_auth_header}"
+        'Content-Type' => 'application/json'
       }
+
+      if oauth_token
+        default['X-Airbnb-Oauth-Token'] = oauth_token
+        default['X-Airbnb-API-Key'] = id
+      else
+        default['Authorization'] = "Basic #{basic_auth_header}"
+      end
+      default
     end
 
     def basic_auth_header

data/lib/airbnb_api/errors/errors.rb

@@ -0,0 +1,8 @@
+module AirbnbApi
+  module Errors
+    class BadRequest < StandardError
+    end
+    class InvalidClient < StandardError
+    end
+  end
+end

data/lib/airbnb_api/resource.rb

@@ -0,0 +1,30 @@
+module AirbnbApi
+  module Resource
+    def initialize(attributes)
+      self.attributes = attributes
+    end
+
+    def attributes=(attributes)
+      @attributes = attributes
+      attributes.each do |attribute, value|
+        if respond_to?(writer = attribute.to_s + '=')
+          send(writer, value)
+        else
+          # self.class.logger.warn "`#{attribute}' is not a listed attribute for #{self.class}"
+        end
+      end
+    end
+
+    module ClassMethods
+      attr_reader :attributes
+
+      def attributes(attributes)
+        attr_accessor(*@attributes = attributes)
+      end
+
+      def build(attributes)
+        new(attributes)
+      end
+    end
+  end
+end

data/lib/airbnb_api/resource/listing.rb

@@ -0,0 +1,51 @@
+module AirbnbApi
+  module Resource
+    class Listing
+      include AirbnbApi::Resource
+      extend AirbnbApi::Resource::ClassMethods
+
+      attributes %i[
+        id
+        name
+        property_type_category
+        room_type_category
+        bedrooms
+        bathrooms
+        beds
+        bed_type_category
+        amenity_categories
+        requested_approval_status_category
+        has_availability
+        permit_or_tax_id
+        apt
+        street
+        city
+        state
+        zipcode
+        country_code
+        lat
+        lng
+        user_defined_location
+        directions
+        check_in_time
+        check_in_time_ends_at
+        check_out_time
+        min_nights_input_value
+        max_nights_input_value
+        person_capacity
+        cancellation_policy_category
+        listing_currency
+        listing_price
+        listing_weekend_price
+        listing_weekly_price
+        listing_monthly_price
+        listing_security_deposit
+        listing_cleaning_fee
+        guests_included
+        listing_extra_person_price
+        instant_book_welcome_message
+        synchronization_category
+      ]
+    end
+  end
+end

data/lib/airbnb_api/resource/token.rb

@@ -0,0 +1,15 @@
+module AirbnbApi
+  module Resource
+    class Token
+      include AirbnbApi::Resource
+      extend AirbnbApi::Resource::ClassMethods
+
+      attributes %i[
+        access_token
+        expires_at
+        refresh_token
+        user_id
+      ]
+    end
+  end
+end

data/lib/airbnb_api/service.rb

@@ -0,0 +1,32 @@
+module AirbnbApi
+  module Service
+    def initialize(client)
+      @client = client
+    end
+
+    def build(attributes)
+      resource_class.new attributes
+    end
+
+    module ClassMethods
+      attr_accessor :path
+      attr_reader :requires_oauth_token
+      def set_path(path)
+        @path = path
+      end
+
+      def require_oauth_token
+        @requires_oauth_token = true
+      end
+
+      def can_use_client?(client)
+        requires_oauth_token? == client.oauth_token?
+      end
+
+      def requires_oauth_token?
+        @requires_oauth_token == true
+      end
+
+    end
+  end
+end

data/lib/airbnb_api/service/listing.rb

@@ -0,0 +1,19 @@
+module AirbnbApi
+  module Service
+    class Listing
+      include AirbnbApi::Service
+      extend AirbnbApi::Service::ClassMethods
+      include AirbnbApi::APIOperations::Find
+      include AirbnbApi::APIOperations::Create
+
+      set_path '/listings'
+      require_oauth_token
+
+      private
+
+      def resource_class
+        AirbnbApi::Resource::Listing
+      end
+    end
+  end
+end

data/lib/airbnb_api/service/token.rb

@@ -0,0 +1,26 @@
+module AirbnbApi
+  module Service
+    class Token
+      include AirbnbApi::Service
+      include AirbnbApi::APIOperations::Create
+      include AirbnbApi::APIOperations::Find
+      extend AirbnbApi::Service::ClassMethods
+
+      set_path '/oauth2/authorizations'
+
+      def create_from_code(code)
+        build @client.post(self.class.path.to_s, { code: code }.to_json)
+      end
+
+      def refresh_token(refresh_token)
+        build @client.post(self.class.path.to_s, { refresh_token: refresh_token }.to_json)
+      end
+
+      private
+
+      def resource_class
+        AirbnbApi::Resource::Token
+      end
+    end
+  end
+end

data/lib/airbnb_api/util/error_handling.rb

@@ -0,0 +1,23 @@
+module AirbnbApi
+  module Util
+    class ErrorHandling < Faraday::Response::Middleware
+      ERROR_MAP = {
+        400 => AirbnbApi::Errors::BadRequest,
+        401 => true,
+        402 => true,
+        403 => true,
+        404 => true,
+        405 => true,
+        406 => true,
+        422 => true,
+        429 => true,
+        500 => true
+      }.freeze
+
+      def on_complete(response)
+        key = response[:status].to_i
+        raise ERROR_MAP[key], response if ERROR_MAP.key? key
+      end
+    end
+  end
+end

data/lib/airbnb_api/version.rb

@@ -1,3 +1,3 @@
 module AirbnbApi
-  VERSION = "0.1.0"
+  VERSION = '0.2.0'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: airbnb_api
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Dennis van der Vliet
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-02-26 00:00:00.000000000 Z
+date: 2018-03-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -80,6 +80,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  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'
 - !ruby/object:Gem::Dependency
   name: webmock
   requirement: !ruby/object:Gem::Requirement
@@ -113,7 +127,17 @@ files:
 - bin/console
 - bin/setup
 - lib/airbnb_api.rb
+- lib/airbnb_api/api_operations/create.rb
+- lib/airbnb_api/api_operations/find.rb
 - lib/airbnb_api/client.rb
+- lib/airbnb_api/errors/errors.rb
+- lib/airbnb_api/resource.rb
+- lib/airbnb_api/resource/listing.rb
+- lib/airbnb_api/resource/token.rb
+- lib/airbnb_api/service.rb
+- lib/airbnb_api/service/listing.rb
+- lib/airbnb_api/service/token.rb
+- lib/airbnb_api/util/error_handling.rb
 - lib/airbnb_api/version.rb
 homepage: https://github.com/dennisvdvliet/airbnb_api
 licenses:
@@ -135,9 +159,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.8
+rubygems_version: 2.7.3
 signing_key: 
 specification_version: 4
 summary: API Client for Airbnb API
 test_files: []
-has_rdoc: