tops_connect 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: ef41f896def4a415b9352eac45c108d3df881897
+  data.tar.gz: 79e157ba0b46043b4ef3442b0e31367ca1bde6c0
+SHA512:
+  metadata.gz: be7a999606f4e2d71483ed54a063cdb6d8c5361d260c81ee7bc42d93f2d4df20f48a225a00a3b579468b89def7a320dbce5804df44486ef2ad55cac95f244dd0
+  data.tar.gz: d69fae0bc8c97f2209f0e47f4e3761d4d68759d42c124757970a95c60cf02bcc1317b31df8315b2e005b6159000dcf545c79e93dafce064772ffd0cd0808449d

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,23 @@
+AllCops:
+  Include:
+    - Gemfile
+    - Rakefile
+  TargetRubyVersion: 2.3
+
+Metrics/AbcSize:
+  Enabled: false
+
+Metrics/CyclomaticComplexity:
+  Enabled: false
+
+Metrics/MethodLength:
+  Max: 32
+
+Metrics/PerceivedComplexity:
+  Enabled: false
+
+Style/Documentation:
+  Enabled: false
+
+Style/MultilineMethodCallIndentation:
+  Enabled: false

data/Gemfile

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in tops_connect.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Steven Hoffman
+
+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,51 @@
+# TopsConnect
+
+TopsConnect is a Ruby gem for accessing the Tops Connect API.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'tops_connect'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install tops_connect
+
+## Usage
+
+```ruby
+TopsConnect.configure do |config|
+  config.subscription_key = '0123456789abcdef0123456789abcdef'
+  config.client_id = '00000000-1111-2222-3333-444444444444'
+  config.software_key = '55555555-6666-7777-8888-999999999999'
+  config.community_api_key = 'AAAAAAAA-BBBB-CCCC-DDDD-EEEEEEEEEEEE'
+  config.zone = :broad
+end
+
+tops = TopsConnect::Client.new
+
+tops.communities.each do |community|
+  puts community['Name']
+end
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/ValenciaMgmt/tops_connect.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+require 'rspec/core/rake_task'
+require 'bundler/gem_tasks'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'bundler/setup'
+require 'tops_connect'
+
+# 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.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require 'irb'
+IRB.start

data/bin/setup

@@ -0,0 +1,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/tops_connect.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+require 'base64'
+require 'httparty'
+require 'json'
+
+require 'tops_connect/communities'
+require 'tops_connect/owners'
+
+require 'tops_connect/configuration'
+require 'tops_connect/client'
+require 'tops_connect/version'
+
+module TopsConnect
+  class << self
+    attr_accessor :configuration
+
+    def configure
+      self.configuration ||= Configuration.new
+
+      yield(configuration) if block_given?
+
+      configuration
+    end
+  end
+end

data/lib/tops_connect/client.rb

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+module TopsConnect
+  class Client
+    include HTTParty
+    include TopsConnect::Communities
+    include TopsConnect::Owners
+
+    headers 'Content-Type' => 'application/json'
+    headers 'api-version' => '1'
+
+    base_uri 'https://topsconnectapi.azure-api.net'
+
+    def initialize
+      authorization = Base64.encode64 [
+        TopsConnect.configuration.client_id,
+        TopsConnect.configuration.software_key
+      ].join(':')
+
+      self.class.headers(
+        'authorization' => "Basic #{authorization}",
+        'community-api-key' => TopsConnect.configuration.community_api_key
+      )
+
+      @subscription_key = TopsConnect.configuration.subscription_key
+    end
+
+    def get(endpoint, parameters = {})
+      response = self.class.get(
+        "/#{TopsConnect.configuration.zone}/api#{endpoint}",
+        query: parameters.merge('subscription-key' => @subscription_key)
+      )
+
+      case response.code
+      when 200
+        response.parsed_response
+      when 400
+        raise BadRequest, response.parsed_response['Message']
+      else
+        raise "#{response.code}: #{response.parsed_response['Message']}"
+      end
+    end
+
+    class BadRequest < Exception
+    end
+  end
+end

data/lib/tops_connect/communities.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+module TopsConnect
+  module Communities
+    # Method: GET
+    # Endpoint: Community_GetList
+    def communities
+      get '/community'
+    end
+
+    # Method: GET
+    # Endpoint: Community_Get
+    def community(community_id)
+      get "/community/#{community_id.to_i}"
+    end
+  end
+end

data/lib/tops_connect/configuration.rb

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+module TopsConnect
+  class Configuration
+    attr_reader :subscription_key, :client_id, :software_key,
+                :community_api_key, :zone
+
+    def initialize
+    end
+
+    def subscription_key=(key)
+      unless key =~ /\A\h{32}\z/i
+        raise 'Invalid TOPS Subscription Key. Expected 32 hex characters.'
+      end
+
+      @subscription_key = key.downcase
+    end
+
+    def client_id=(key)
+      unless key =~ /\A\h{8}-\h{4}-\h{4}-\h{4}-\h{12}\z/
+        raise 'Invalid TOPS Client ID. Expected a GUID.'
+      end
+
+      @client_id = key.upcase
+    end
+
+    def software_key=(key)
+      unless key =~ /\A\h{8}-\h{4}-\h{4}-\h{4}-\h{12}\z/
+        raise 'Invalid TOPS Software Key. Expected a GUID.'
+      end
+
+      @software_key = key.upcase
+    end
+
+    def community_api_key=(key)
+      unless key =~ /\A\h{8}-\h{4}-\h{4}-\h{4}-\h{12}\z/
+        raise 'Invalid TOPS Community API Key. Expected a GUID.'
+      end
+
+      @community_api_key = key.upcase
+    end
+
+    def zone=(new_zone)
+      unless %i(broad limited sandbox).include?(new_zone)
+        raise 'Invalid TOPS Zone. Accepted values are broad, limited, sandbox.'
+      end
+
+      @zone = new_zone
+    end
+  end
+end

data/lib/tops_connect/owners.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+module TopsConnect
+  module Owners
+    # Method: GET
+    # Endpoint: Owner_Get
+    def owner(owner_id)
+      get "/owner/#{owner_id.to_i}"
+    end
+
+    # Method: GET
+    # Endpoint: Owner_GetList
+    def owners(property_id = nil)
+      parameters = {}
+      parameters['PropertyKey'] = property_id.to_i if property_id
+
+      get '/owner', parameters
+    end
+
+    # Method: GET
+    # Endpoint: Balance_Get
+    def balance(owner_id)
+      get "/balance/#{owner_id.to_i}"
+    end
+  end
+end

data/lib/tops_connect/version.rb

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+module TopsConnect
+  VERSION = '0.1.0'
+end

data/tops_connect.gemspec

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'tops_connect/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'tops_connect'
+  spec.version       = TopsConnect::VERSION
+  spec.authors       = ['Steven Hoffman']
+  spec.email         = ['shoffman@valenciamgmt.com']
+
+  spec.summary       = 'Make use of the Tops Connect API'
+  spec.homepage      = 'https://github.com/ValenciaMgmt/tops_connect'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0")
+                       .reject { |f| f.match(%r{^spec/}) }
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler', '~> 1.10'
+  spec.add_development_dependency 'rake', '>= 10'
+  spec.add_development_dependency 'rspec'
+  spec.add_development_dependency 'webmock'
+
+  spec.add_dependency 'httparty', '~> 0.13'
+end

metadata

@@ -0,0 +1,130 @@
+--- !ruby/object:Gem::Specification
+name: tops_connect
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Steven Hoffman
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-04-01 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '10'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  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
+    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: httparty
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.13'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.13'
+description: 
+email:
+- shoffman@valenciamgmt.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/tops_connect.rb
+- lib/tops_connect/client.rb
+- lib/tops_connect/communities.rb
+- lib/tops_connect/configuration.rb
+- lib/tops_connect/owners.rb
+- lib/tops_connect/version.rb
+- tops_connect.gemspec
+homepage: https://github.com/ValenciaMgmt/tops_connect
+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.5.1
+signing_key: 
+specification_version: 4
+summary: Make use of the Tops Connect API
+test_files: []