myvr 0.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 46a476e0ad9beca3e9b4f43790c54cbde5281a43
+  data.tar.gz: 13cee268b5ab3cc57988100ee89c47ef742a8ea7
+SHA512:
+  metadata.gz: 74c28bbfa0f70f05d1ee2b2da7c379e509cb196e48c8803b714b7892418b56263fb3de1cec7ddd04a954bce1fac10a1da3b6d192267033fc129d19dfa596808b
+  data.tar.gz: 7e04def406f644f3a544925202a20bd247823cbb954c82f9ff4c3d6ee0890216e465838697115d4a8715e77381bebcd637156a72a7429b6fd51480dcdbb9e165

data/README.md

@@ -0,0 +1,71 @@
+# MyVR
+
+The purpose of this library is to communicate with the MyVR API using Ruby!
+
+To view the original API docs check out
+[developer.myvr.com](https://developer.myvr.com/).
+
+## Installation
+
+```sh
+gem install myvr
+```
+
+## Configuration
+
+There are two different ways to authenticate with MyVR. MyVR Connect using
+OAuth, or Application level authentication.
+
+
+To start using the MyVR API you will need to [register an application with
+MyVR](https://myvr.com/account/#/settings/api/).
+
+
+Your new application will be assigned a consumer key/secret pair that identifies
+your application to Twitter. This is all you need to configure your client for
+application-only authentication.
+
+```ruby
+client = MyVR::Client.new(access_key: 'YOUR_ACCESS_KEY')
+client.properties
+```
+
+
+### Roadmap
+
++ Properties
+  + List Properties :shipit:
+  + Retrieve Property :shipit:
+  + Create Property
+  + Update Property
+  + Delete Property
++ Rates
+  + List Rates
+  + Retrieve Rate
+  + Create Rate
+  + Update Rate
+  + Delete Rate
++ Fees
+  + List Fees
+  + Retrieve Fees
+  + Create Fees
+  + Update Fees
+  + Delete Fees
++ Photos
+  + List Photos
+  + Retrieve Photos
+  + Create Photos
+  + Update Photos
+  + Delete Photos
++ Amenities
+  + List Amenities
+  + Retrieve Amenities
+  + Create Amenities
+  + Update Amenities
+  + Delete Amenities
++ Rooms
+  + List Rooms
+  + Retrieve Rooms
+  + Create Rooms
+  + Update Rooms
+  + Delete Rooms

data/lib/myvr.rb

@@ -0,0 +1,20 @@
+require 'addressable/uri'
+require 'curb'
+require 'json'
+
+require_relative './myvr/version'
+require_relative './myvr/api/amenities'
+require_relative './myvr/api/fees'
+require_relative './myvr/api/photos'
+require_relative './myvr/api/properties'
+require_relative './myvr/api/rates'
+require_relative './myvr/api/rooms'
+require_relative './myvr/client'
+
+require_relative './myvr/model'
+require_relative './myvr/amenity'
+require_relative './myvr/fee'
+require_relative './myvr/photo'
+require_relative './myvr/property'
+require_relative './myvr/rate'
+require_relative './myvr/room'

data/lib/myvr/amenity.rb

@@ -0,0 +1,4 @@
+module MyVR
+  class Amenity < MyVR::Model
+  end
+end

data/lib/myvr/api/amenities.rb

@@ -0,0 +1,21 @@
+module MyVR
+  module API
+    module Amenities
+      def amenities!
+        data = get_objects("/v1/amenities/")
+        data.map do |fee|
+          MyVR::Amenity.new(fee)
+        end
+      end
+
+      def amenities
+        @amenities ||= amenities!
+      end
+
+      def fee(id)
+        data = get_object("/v1/amenities/#{ id }/")
+        MyVR::Amenity.new(data)
+      end
+    end
+  end
+end

data/lib/myvr/api/fees.rb

@@ -0,0 +1,21 @@
+module MyVR
+  module API
+    module Fees
+      def fees!
+        data = get_objects("/v1/fees/")
+        data.map do |fee|
+          MyVR::Fee.new(fee)
+        end
+      end
+
+      def fees
+        @fees ||= fees!
+      end
+
+      def fee(id)
+        data = get_object("/v1/fees/#{ id }/")
+        MyVR::Fee.new(data)
+      end
+    end
+  end
+end

data/lib/myvr/api/photos.rb

@@ -0,0 +1,21 @@
+module MyVR
+  module API
+    module Photos
+      def photos!
+        data = get_objects("/v1/photos/")
+        data.map do |photo|
+          MyVR::Photo.new(photo)
+        end
+      end
+
+      def photos
+        @photos ||= photos!
+      end
+
+      def photo(id)
+        data = get_object("/v1/photos/#{ id }/")
+        MyVR::Photo.new(data)
+      end
+    end
+  end
+end

data/lib/myvr/api/properties.rb

@@ -0,0 +1,21 @@
+module MyVR
+  module API
+    module Properties
+      def properties!(search = '')
+        data = get_objects("/v1/properties/", { name: search })
+        data.map do |property|
+          MyVR::Property.new(property)
+        end
+      end
+
+      def properties(search='')
+        @properties ||= properties!(search)
+      end
+
+      def property(id)
+        data = get_object("/v1/properties/#{ id }/")
+        MyVR::Property.new(data)
+      end
+    end
+  end
+end

data/lib/myvr/api/rates.rb

@@ -0,0 +1,21 @@
+module MyVR
+  module API
+    module Rates
+      def rates!
+        data = get_objects("/v1/rates/")
+        data.map do |rate|
+          MyVR::Rate.new(rate)
+        end
+      end
+
+      def rates
+        @rates ||= rates!
+      end
+
+      def rate(id)
+        data = get_object("/v1/rates/#{ id }/")
+        MyVR::Rate.new(data)
+      end
+    end
+  end
+end

data/lib/myvr/api/rooms.rb

@@ -0,0 +1,21 @@
+module MyVR
+  module API
+    module Rooms
+      def rooms!
+        data = get_objects("/v1/rooms/")
+        data.map do |room|
+          MyVR::Room.new(room)
+        end
+      end
+
+      def rooms
+        @rooms ||= rooms!
+      end
+
+      def room(id)
+        data = get_object("/v1/rooms/#{ id }/")
+        MyVR::Room.new(data)
+      end
+    end
+  end
+end

data/lib/myvr/client.rb

@@ -0,0 +1,62 @@
+require 'active_support/inflector'
+
+module MyVR
+  class Client
+    include MyVR::API::Amenities
+    include MyVR::API::Fees
+    include MyVR::API::Photos
+    include MyVR::API::Properties
+    include MyVR::API::Rates
+    include MyVR::API::Rooms
+
+    attr_accessor :access_key, :last_response
+
+    def initialize(options = {})
+      @last_response = nil
+      options.each do |key, value|
+        instance_variable_set("@#{ key }", value)
+      end
+      yield(self) if block_given?
+    end
+
+    def user_agent
+      @user_agent ||= "MyVRRubyGem/#{ MyVR::Version }"
+    end
+
+    def get_objects(path, params={})
+      response = request(:get, path, params.dup)
+      response['results']
+    end
+
+    def get_object(path, params={})
+      request(:get, path, params.dup)
+    end
+
+    def request(http_method, path, params={})
+      url = base_url(path, params.dup)
+      c = Curl::Easy.new(url)
+      c.http_auth_types = :basic
+      c.username = access_key
+      c.send(http_method)
+      p JSON.parse(c.body_str)
+    end
+
+    def base_url(path, params={})
+      Addressable::URI.new(
+        host: 'api.local.myvr.com',
+        port: 8000,
+        scheme: 'http',
+        path: path,
+        query_values: params
+      )
+    end
+
+    private
+
+    def assert_class_type(klass)
+      unless klass.is_a?(String) || klass.is_a?(Class)
+        raise 'Class of object(s) to return must be string or class'
+      end
+    end
+  end
+end

data/lib/myvr/error.rb

@@ -0,0 +1,4 @@
+module MyVR
+  module Error
+  end
+end

data/lib/myvr/fee.rb

@@ -0,0 +1,4 @@
+module MyVR
+  class Fee < MyVR::Model
+  end
+end

data/lib/myvr/model.rb

@@ -0,0 +1,9 @@
+module MyVR
+  class Model
+    def initialize(attrs = {})
+      attrs.each do |key, value|
+        instance_variable_set("@#{ key }", value)
+      end
+    end
+  end
+end

data/lib/myvr/photo.rb

@@ -0,0 +1,4 @@
+module MyVR
+  class Photo < MyVR::Model
+  end
+end

data/lib/myvr/property.rb

@@ -0,0 +1,31 @@
+module MyVR
+  class Property < MyVR::Model
+    attr_reader(
+      :uri,
+      :id,
+      :externalId,
+      :name,
+      :shortCode,
+      :active,
+      :bedrooms,
+      :bathrooms,
+      :accommodates,
+      :size,
+      :type,
+      :weekendNights,
+      :currency,
+      :allowTurns,
+      :checkInTime,
+      :checkOutTime,
+      :manual,
+      :suitablePets,
+      :suitableElderly,
+      :suitableKids,
+      :suitableGroups,
+      :suitableSmoking,
+      :suitableHandicap,
+      :amenities,
+      :created
+    )
+  end
+end

data/lib/myvr/rate.rb

@@ -0,0 +1,4 @@
+module MyVR
+  class Rate < MyVR::Model
+  end
+end

data/lib/myvr/room.rb

@@ -0,0 +1,5 @@
+module MyVR
+  class Room < MyVR::Model
+  end
+end
+

data/lib/myvr/version.rb

@@ -0,0 +1,32 @@
+module MyVR
+  module Version
+  module_function
+    def major
+      0
+    end
+
+    def minor
+      0
+    end
+
+    def patch
+      0
+    end
+
+    def to_h
+      {
+        major: major,
+        minor: minor,
+        patch: patch,
+      }
+    end
+
+    def to_a
+      [major, minor, patch].compact
+    end
+
+    def to_s
+      to_a.join('.')
+    end
+  end
+end

data/myvr.gemspec

@@ -0,0 +1,21 @@
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'myvr/version'
+
+Gem::Specification.new do |s|
+  s.add_dependency 'addressable', '~> 2.3'
+  s.add_dependency 'curb', '~> 0.9.1'
+  s.add_dependency 'json', '~> 1.8', '>= 1.8.3'
+  s.add_development_dependency 'bundler', '~> 1.0'
+  s.name          = 'myvr'
+  s.version       = MyVR::Version
+  s.date          = '2016-01-07'
+  s.description   = 'Ruby interface for the MyVR.com API'
+  s.summary       = s.description
+  s.authors       = ['CJ Avilla']
+  s.email         = 'cavilla@myvr.com'
+  s.files         = %w(README.md myvr.gemspec) + Dir['lib/**/*.rb']
+  s.homepage      = 'https://github.com/w1zeman1p/myvr'
+  s.license       = 'MIT'
+  s.require_paths = 'lib'
+end

metadata

@@ -0,0 +1,124 @@
+--- !ruby/object:Gem::Specification
+name: myvr
+version: !ruby/object:Gem::Version
+  version: 0.0.0
+platform: ruby
+authors:
+- CJ Avilla
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-01-07 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: addressable
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.3'
+- !ruby/object:Gem::Dependency
+  name: curb
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.1
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.8.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.8.3
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+description: Ruby interface for the MyVR.com API
+email: cavilla@myvr.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- lib/myvr.rb
+- lib/myvr/amenity.rb
+- lib/myvr/api/amenities.rb
+- lib/myvr/api/fees.rb
+- lib/myvr/api/photos.rb
+- lib/myvr/api/properties.rb
+- lib/myvr/api/rates.rb
+- lib/myvr/api/rooms.rb
+- lib/myvr/client.rb
+- lib/myvr/error.rb
+- lib/myvr/fee.rb
+- lib/myvr/model.rb
+- lib/myvr/photo.rb
+- lib/myvr/property.rb
+- lib/myvr/rate.rb
+- lib/myvr/room.rb
+- lib/myvr/version.rb
+- myvr.gemspec
+homepage: https://github.com/w1zeman1p/myvr
+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.4.5
+signing_key: 
+specification_version: 4
+summary: Ruby interface for the MyVR.com API
+test_files: []