apartment_ratings 0.0.1 → 1.0.0

data/Gemfile

@@ -1,7 +1,9 @@
 source 'http://rubygems.org'
 
-gem 'hashie', git: 'https://github.com/intridea/hashie.git', branch: :master
+gem 'hashie', '~> 3.3.1'
+gem 'tnt', '~> 0.1.0'
 gem 'faraday', '~> 0.9.0'
+gem 'faraday_middleware', '~> 0.9.0'
 
 group :development do
   gem 'pry'

data/Gemfile.lock

@@ -1,10 +1,3 @@
-GIT
-  remote: https://github.com/intridea/hashie.git
-  revision: 8b4ffbd6aa2ff9e6aeccd8181c82a85ffd1eea7a
-  branch: master
-  specs:
-    hashie (3.1.1)
-
 GEM
   remote: http://rubygems.org/
   specs:
@@ -18,6 +11,8 @@ GEM
     docile (1.1.5)
     faraday (0.9.0)
       multipart-post (>= 1.2, < 3)
+    faraday_middleware (0.9.1)
+      faraday (>= 0.7.4, < 0.10)
     git (1.2.7)
     github_api (0.11.3)
       addressable (~> 2.3)
@@ -27,6 +22,7 @@ GEM
       multi_json (>= 1.7.5, < 2.0)
       nokogiri (~> 1.6.0)
       oauth2
+    hashie (3.3.1)
     highline (1.6.21)
     jeweler (2.0.1)
       builder
@@ -92,6 +88,7 @@ GEM
     simplecov-html (0.8.0)
     slop (3.5.0)
     thread_safe (0.3.4)
+    tnt (0.1.0)
 
 PLATFORMS
   ruby
@@ -99,7 +96,8 @@ PLATFORMS
 DEPENDENCIES
   bundler (~> 1.0)
   faraday (~> 0.9.0)
-  hashie!
+  faraday_middleware (~> 0.9.0)
+  hashie (~> 3.3.1)
   jeweler (~> 2.0.1)
   pry
   rdoc (~> 3.12)
@@ -107,3 +105,4 @@ DEPENDENCIES
   rspec (~> 3.0)
   rubocop (>= 0.21.0)
   simplecov
+  tnt (~> 0.1.0)

data/README.md

@@ -1,5 +1,7 @@
 # ApartmentRatings [![Build Status](https://travis-ci.org/gregory/apartment_ratings.svg)](https://travis-ci.org/gregory/apartment_ratings)
 
+## THIS IS A WIP, WATING FOR CREDENTIALS TO TEST :)
+
 Description goes here.
 
 ## Contributing to apartment_ratings

data/VERSION

@@ -1 +1 @@
-0.0.1
+1.0.0

data/apartment_ratings.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = "apartment_ratings"
-  s.version = "0.0.1"
+  s.version = "1.0.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["gregory"]
-  s.date = "2014-07-08"
+  s.date = "2014-09-25"
   s.description = "Ruby client for ApartmentRating API"
   s.email = "greg2502@gmail.com"
   s.extra_rdoc_files = [
@@ -33,6 +33,7 @@ Gem::Specification.new do |s|
     "lib/apartment_ratings/client.rb",
     "lib/apartment_ratings/complex.rb",
     "lib/apartment_ratings/configuration.rb",
+    "lib/apartment_ratings/errors.rb",
     "lib/apartment_ratings/review.rb",
     "lib/apartment_ratings/reviews/rating.rb",
     "lib/apartment_ratings/reviews/response.rb",
@@ -43,6 +44,7 @@ Gem::Specification.new do |s|
     "spec/apartment_ratings/reviews/rating_spec.rb",
     "spec/apartment_ratings/reviews/response_spec.rb",
     "spec/apartment_ratings_spec.rb",
+    "spec/spec.yml.sample",
     "spec/spec_helper.rb"
   ]
   s.homepage = "http://github.com/gregory/apartment_ratings"
@@ -55,8 +57,10 @@ Gem::Specification.new do |s|
     s.specification_version = 3
 
     if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
-      s.add_runtime_dependency(%q<hashie>, [">= 0"])
+      s.add_runtime_dependency(%q<hashie>, ["~> 3.3.1"])
+      s.add_runtime_dependency(%q<tnt>, ["~> 0.1.0"])
       s.add_runtime_dependency(%q<faraday>, ["~> 0.9.0"])
+      s.add_runtime_dependency(%q<faraday_middleware>, ["~> 0.9.0"])
       s.add_development_dependency(%q<pry>, [">= 0"])
       s.add_development_dependency(%q<rr>, ["~> 1.1.2"])
       s.add_development_dependency(%q<rspec>, ["~> 3.0"])
@@ -66,8 +70,10 @@ Gem::Specification.new do |s|
       s.add_development_dependency(%q<simplecov>, [">= 0"])
       s.add_development_dependency(%q<rubocop>, [">= 0.21.0"])
     else
-      s.add_dependency(%q<hashie>, [">= 0"])
+      s.add_dependency(%q<hashie>, ["~> 3.3.1"])
+      s.add_dependency(%q<tnt>, ["~> 0.1.0"])
       s.add_dependency(%q<faraday>, ["~> 0.9.0"])
+      s.add_dependency(%q<faraday_middleware>, ["~> 0.9.0"])
       s.add_dependency(%q<pry>, [">= 0"])
       s.add_dependency(%q<rr>, ["~> 1.1.2"])
       s.add_dependency(%q<rspec>, ["~> 3.0"])
@@ -78,8 +84,10 @@ Gem::Specification.new do |s|
       s.add_dependency(%q<rubocop>, [">= 0.21.0"])
     end
   else
-    s.add_dependency(%q<hashie>, [">= 0"])
+    s.add_dependency(%q<hashie>, ["~> 3.3.1"])
+    s.add_dependency(%q<tnt>, ["~> 0.1.0"])
     s.add_dependency(%q<faraday>, ["~> 0.9.0"])
+    s.add_dependency(%q<faraday_middleware>, ["~> 0.9.0"])
     s.add_dependency(%q<pry>, [">= 0"])
     s.add_dependency(%q<rr>, ["~> 1.1.2"])
     s.add_dependency(%q<rspec>, ["~> 3.0"])

data/lib/apartment_ratings.rb

@@ -1,4 +1,5 @@
 require 'hashie'
+require 'tnt'
 
 $LOAD_PATH.unshift(File.join(File.dirname(__FILE__), 'apartment_ratings'))
 
@@ -8,6 +9,7 @@ module ApartmentRatings
   autoload :Address, 'address'
   autoload :Complex, 'complex'
   autoload :Review, 'review'
+  autoload :Errors, 'errors'
 
   module Reviews
     autoload :Rating, 'reviews/rating'
@@ -22,12 +24,44 @@ module ApartmentRatings
     @config = Configuration.new.tap { |configuration| yield(configuration) }
   end
 
+  def self.credentials
+    if config.nil?
+      fail InvalidConfig
+    else
+      config.select { |key, _| [:username, :password].include?(key) }
+    end
+  end
+
   def self.client
-    options = {
-      username: config.username,
-      password: config.password,
-      api_base_path: config.api_base_path
+    @client ||= begin
+      fail Errors::InvalidConfig if config.nil?
+      options = {
+        api_base_path: config.api_base_path
+      }
+      Client.new(options)
+    end
+  end
+
+  def self.post(url = nil, params = {}, headers = nil, errors_opts = { token: 0 }, &block)
+    payload     = default_params.merge(params)
+    json_result = client.connection.post(url, payload, headers).body
+    result      = JSON.parse json_result
+
+    if !result['errors'].nil? && !result['errors']['serviceToken'].nil?
+      # Mostlikely the token expired, lets try to refresh it
+      fail Errors::InvalidToken unless errors_opts[:token] < ApartmentRatings.config.max_token_retry
+
+      client.refresh_token
+      return post(url, params, headers, { token: (errors_opts[:token] + 1) }, &block)
+    else
+      block.call(result)
+    end
+  end
+
+  def self.default_params
+    {
+      serviceToken: client.token,
+      username: credentials[:username]
     }
-    Client.new(options)
   end
 end

data/lib/apartment_ratings/address.rb

@@ -1,5 +1,7 @@
 module ApartmentRatings
   class Address < Hashie::Trash
+    include Hashie::Extensions::IndifferentAccess
+
     property :full_address
 
     def self.coerce(raw_address)

data/lib/apartment_ratings/client.rb

@@ -1,31 +1,38 @@
 require 'faraday'
+require 'faraday_middleware'
 
 module ApartmentRatings
   class Client
+    attr_reader :connection
+
     def initialize(options = {})
       path = options.fetch(:api_base_path)
-      params = {
-        username: options.fetch(:username),
-        password: options.fetch(:password)
-      }
 
-      @client = Faraday.new(path, params) do |faraday|
-        faraday.response :json, content_type: /\bjson\z/
+      @connection = Faraday.new(path) do |faraday|
+        faraday.request :url_encoded # Unfortunately, we need to encode post and put params
+        faraday.request :json
+
+        # NOTE: Unfortunately, the response content type is not json... But we know it is.
+        faraday.response :json, content_type: /\Atext\/html;charset=ISO-8859-1\z/
         faraday.response :logger if ApartmentRatings.config.debug
 
         faraday.adapter ApartmentRatings.config.faraday_adapter || Faraday.default_adapter
       end
     end
 
-    def complexes
-      result = @client.get('index')
-      # TODO: store the result and hangle unsuccessful response
-      result['complexes'].map { |complex_json| Complex.new complex_json }
+    def token
+      @token ||= refresh_token
     end
 
-    def complex(id)
-      result = @client.get('complex', complexId: id)
-      Complex.new result
+    def refresh_token
+      @token = nil
+      result = JSON.parse @connection.post('login', ApartmentRatings.credentials.merge(format: 'json')).body
+
+      if result['success']
+        @token = result['response']
+      else
+        fail Errors::InvalidToken
+      end
     end
   end
 end

data/lib/apartment_ratings/complex.rb

@@ -1,5 +1,6 @@
 module ApartmentRatings
   class Complex < Hashie::Trash
+    include Hashie::Extensions::IndifferentAccess
     include Hashie::Extensions::IgnoreUndeclared
     include Hashie::Extensions::Coercion
 
@@ -8,6 +9,7 @@ module ApartmentRatings
     property :address, from: :propertyAddress
     property :propertyAddress
     property :feedUrl
+    property :url, from: :propertyUrl
 
     property :apartmentRating
     property :averageRating
@@ -17,5 +19,26 @@ module ApartmentRatings
     coerce_key :address, Address
     coerce_key :averageRating, Hash[String => Reviews::Rating]
     coerce_key :reviews, Set[Review]
+
+    def self.all
+      ApartmentRatings.post('index') do |result|
+        if result['success']
+          result['complexes'].map { |complex_json| new complex_json }
+        else
+          fail StandardError
+        end
+      end
+    end
+
+    def self.find(id)
+      ApartmentRatings.post('complex', complexId: id) do |result|
+        if result['success']
+          default_options = { id: id }
+          new default_options.merge(result)
+        else
+          fail Errors::InvalidComplexId.new(id, result['errorMessage'])
+        end
+      end
+    end
   end
 end

data/lib/apartment_ratings/configuration.rb

@@ -2,12 +2,17 @@ module ApartmentRatings
   class Configuration < Hashie::Dash
     DEFAULTS = {
       format: 'json',
+      debug: false,
       api_base_path: 'https://services.apartmentratings.com/services/rms/v1/',
-      hours_before_token_expiration: 48
+      hours_before_token_expiration: 48,
+      max_token_retry: 2
     }.freeze
 
     property :username
     property :password
+    property :debug, default: DEFAULTS[:debug]
+    property :faraday_adapter
+    property :max_token_retry, default: DEFAULTS[:max_token_retry]
     property :format, default: DEFAULTS[:format]
     property :api_base_path, default: DEFAULTS[:api_base_path]
     property :hours_before_token_expiration, default: DEFAULTS[:hours_before_token_expiration]

data/lib/apartment_ratings/errors.rb

@@ -0,0 +1,19 @@
+module ApartmentRatings
+  module Errors
+    InvalidToken = Tnt.boom do
+      credentials = ApartmentRatings.credentials.map { |k, v| "#{k} => #{v}" }.join(', ')
+      "Unable to retrieve token for the following credentials: #{credentials}"
+    end
+
+    InvalidConfig = Tnt.boom do
+      %s(
+        Please provide valid credentials. Ex:
+        > ApartmentRatings.configure { |c| c.username = 'username'; c.password= 'bar'; }
+      )
+    end
+
+    InvalidComplexId = Tnt.boom do |id, msg|
+      "Invalid Complex id (#{id}) : #{msg}"
+    end
+  end
+end

data/lib/apartment_ratings/review.rb

@@ -1,5 +1,6 @@
 module ApartmentRatings
   class Review < Hashie::Trash
+    include Hashie::Extensions::IndifferentAccess
     include Hashie::Extensions::Coercion
 
     property :datePosted
@@ -7,6 +8,7 @@ module ApartmentRatings
     property :responses
     property :author, from: :reviewerScreenName
     property :rating, from: :starRatings
+    property :updated_at, from: :lastUpdatedDate
     property :url
 
     coerce_key :responses, Set[Reviews::Response]

data/lib/apartment_ratings/reviews/rating.rb

@@ -1,6 +1,7 @@
 module ApartmentRatings
   module Reviews
     class Rating < Hashie::Trash
+      include Hashie::Extensions::IndifferentAccess
       property :value
 
       def self.coerce(raw_rating)

data/spec/spec.yml.sample

@@ -0,0 +1,3 @@
+credentials:
+  username: foo@bar.com
+  password: password

data/spec/spec_helper.rb

@@ -19,6 +19,7 @@ $LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
 $LOAD_PATH.unshift(File.dirname(__FILE__))
 
 require 'rspec'
+require 'yaml'
 require 'apartment_ratings'
 
 # Requires supporting files with custom matchers and macros, etc,
@@ -27,7 +28,15 @@ Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each { |f| require f }
 
 RSpec.configure do |config|
   config.before :suite do
-    ApartmentRatings.configure do
+    ApartmentRatings.configure do |conf|
+      credentials = settings['credentials']
+
+      conf.username = credentials['username']
+      conf.password = credentials['password']
     end
   end
+
+  def settings
+    @settings ||= YAML.load_file(File.join(File.dirname(File.expand_path(__FILE__)), 'spec.yml'))
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: apartment_ratings
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 1.0.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,24 +9,40 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-07-08 00:00:00.000000000 Z
+date: 2014-09-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: hashie
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ! '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 3.3.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ! '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 3.3.1
+- !ruby/object:Gem::Dependency
+  name: tnt
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.1.0
 - !ruby/object:Gem::Dependency
   name: faraday
   requirement: !ruby/object:Gem::Requirement
@@ -43,6 +59,22 @@ dependencies:
     - - ~>
       - !ruby/object:Gem::Version
         version: 0.9.0
+- !ruby/object:Gem::Dependency
+  name: faraday_middleware
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.9.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.9.0
 - !ruby/object:Gem::Dependency
   name: pry
   requirement: !ruby/object:Gem::Requirement
@@ -195,6 +227,7 @@ files:
 - lib/apartment_ratings/client.rb
 - lib/apartment_ratings/complex.rb
 - lib/apartment_ratings/configuration.rb
+- lib/apartment_ratings/errors.rb
 - lib/apartment_ratings/review.rb
 - lib/apartment_ratings/reviews/rating.rb
 - lib/apartment_ratings/reviews/response.rb
@@ -205,6 +238,7 @@ files:
 - spec/apartment_ratings/reviews/rating_spec.rb
 - spec/apartment_ratings/reviews/response_spec.rb
 - spec/apartment_ratings_spec.rb
+- spec/spec.yml.sample
 - spec/spec_helper.rb
 homepage: http://github.com/gregory/apartment_ratings
 licenses:
@@ -221,7 +255,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 1571250886427044213
+      hash: -426309642446831234
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements: