rentlinx 0.0.1a1 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 56bf022f8acf7102f71aa040e128faca6d8270f3
-  data.tar.gz: bf0058098da091c7e261adf2eec111c44b49ae1c
+  metadata.gz: 62760941602e190d7e71c0a22c7b7c471d3c4e47
+  data.tar.gz: 835279ed9de32624308d7b25363edbb57cdbdaf4
 SHA512:
-  metadata.gz: d71353c3d0d020714c7ff4143ba98eccfb06955774a90869586a2568649f215c3fbb848ee175c116f3a51f9892f3e4db71c6e635a785f192754e13e2a17e1045
-  data.tar.gz: 830da5da63f459bb45d9cfe889a24479e3d61aaf387b59d0366078ae970b490fe8a7de069fe82444e80f60bf90bfbcbebfb26759d84710b64e619919825c83e8
+  metadata.gz: ef753885a804dd79fcbe08be8e8c71b10b2fef8e10cf2d4852551862fd437ec137c9c0bfb930bf4de804f6cf449af158b3614529f2984076ddaac357c803f2eb
+  data.tar.gz: fa4d97045432cca302923b2c4c739b486e5dff802c6fb965d27645315c2116a9f92c2ae2e0b092904894985871114e7f6bab1a8a9172f22c25e50387d17f1dc5

data/README.md

@@ -1,10 +1,54 @@
-# rentlinx_client: Ruby Client Wrapper for the RentLinx API
+[![Gem Version](https://badge.fury.io/rb/rentlinx.svg)](https://rubygems.org/gems/rentlinx)
+[![Build Status](https://travis-ci.org/appfolio/rentlinx_client.svg?branch=master)](https://travis-ci.org/appfolio/rentlinx_client)
+[![Coverage Status](https://coveralls.io/repos/appfolio/rentlinx_client/badge.svg?branch=master)](https://coveralls.io/r/appfolio/rentlinx_client?branch=master)
 
+# rentlinx_client
 
-### Installation
+_rentlinx_client_ is a ruby wrapper for the RentLinx API.
+
+
+## Installation
 
     gem install rentlinx
 
+## Contributing and development
+
+Pull requests are welcome for this gem. New features require writing new
+tests. A pull request be considered for merging once:
+
+* New features are tested
+* All tests pass on Travis CI
+* The code coverage reported by Coveralls does not decrease without reason
+
+### Testing: Code style
+
+Travis CI runs two test suites. The first suite performs a style check with the
+tool rubocop. To run rubocop locally first make sure you have the necessary
+tools:
+
+    bundle install
+
+Then, run rubocop across the project's files:
+
+    rubocop
+
+Not all rubocop's rules are set in stone, so once you are receiving only
+warnings testing rules that may not make sense, please comment on your pull
+request indicating you think the rules should be adjusted with your reasoning.
+
+### Testing: Unit tests
+
+The second suite is running minitest. The simplest way to invoke our minitest
+suite is via:
+
+    rake
+
+The default rake task actually maps to `rake test`. Additionally individual
+test files can be executed via:
+
+    ruby -Ilib:test test/FILENAME.rb
+
+
 ## Copyright and license
 
 Source released under the Simplified BSD License.

data/lib/rentlinx/client.rb

@@ -0,0 +1,36 @@
+require 'httpclient'
+require 'json'
+require 'uri'
+require 'rentlinx/default'
+
+module Rentlinx
+  # Client is the primary interface that users of this gem will utilize.
+  class Client
+    def initialize(username, password, api_url_prefix)
+      @url_prefix = (api_url_prefix + '/').freeze  # Extra slashes are fine
+      @api_token ||= authenticate(username, password)
+    end
+
+    def self.health_check(username, password, api_url_prefix)
+      new(username, password, api_url_prefix)
+    end
+
+    private
+
+    def authenticate(username, password)
+      data = { username: username, password: password }
+      response = request('POST', 'authentication/login', data)
+      response['AccessToken'].freeze
+    end
+
+    def request(method, path, data = nil)
+      options = { body: data.to_json, header: Rentlinx::Default.headers }
+      response = session.request(method, URI.join(@url_prefix, path), options)
+      JSON.parse(response.body)
+    end
+
+    def session
+      @session ||= HTTPClient.new
+    end
+  end
+end

data/lib/rentlinx/default.rb

@@ -0,0 +1,15 @@
+require 'rentlinx/version'
+
+module Rentlinx
+  # The Default module provides the default configuration options.
+  module Default
+    USER_AGENT = "Rentlinx Ruby Client #{Rentlinx::VERSION}".freeze
+
+    class << self
+      def headers
+        { 'Content-Type' => 'application/json',
+          'User-Agent' => USER_AGENT }
+      end
+    end
+  end
+end

data/lib/rentlinx/version.rb

@@ -1,4 +1,4 @@
 # Rentlinx
 module Rentlinx
-  VERSION = '0.0.1a1'
+  VERSION = '0.0.3'
 end

data/lib/rentlinx.rb

@@ -1 +1,10 @@
-require 'rentlinx/version'
+require 'rentlinx/client'
+
+# The Rentlinx module provides the means to interact with the Rentlinx API.
+module Rentlinx
+  class << self
+    def client(*args)
+      @client ||= Rentlinx::Client.new(*args)
+    end
+  end
+end

metadata

@@ -1,15 +1,43 @@
 --- !ruby/object:Gem::Specification
 name: rentlinx
 version: !ruby/object:Gem::Version
-  version: 0.0.1a1
+  version: 0.0.3
 platform: ruby
 authors:
 - AppFolio, Inc.
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-06-04 00:00:00.000000000 Z
-dependencies: []
+date: 2015-06-15 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: httpclient
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.6.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.6.0
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
 description: 
 email: bryce.boe@appfolio.com
 executables: []
@@ -19,6 +47,8 @@ files:
 - LICENSE.txt
 - README.md
 - lib/rentlinx.rb
+- lib/rentlinx/client.rb
+- lib/rentlinx/default.rb
 - lib/rentlinx/version.rb
 homepage: https://github.com/appfolio/rentlinx_client
 licenses:
@@ -35,9 +65,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">"
+  - - ">="
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
 rubyforge_project: 
 rubygems_version: 2.4.3