aladtec 0.2.0 → 0.3.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 5833472c1eeb7a7f359005a98ba355d114fb8223
-  data.tar.gz: 969f3e879943297a501a15253cece2cefbb7facb
+SHA256:
+  metadata.gz: 5fe187974f6bb3afdfee9fa734097e8e9aa644e3d8e6d62eb5c3aeca466e3f84
+  data.tar.gz: 31d54f6839c062dba60924565d4d42e65b4521d106dc0bcc614d61889b87cf63
 SHA512:
-  metadata.gz: afdf0a35e2d5e5960a4958b41044ef0f5a7eb1c6484ccac93d8786ac7c7b6f2b910f3b8cf52f49e73b7d687de4c86b73522911748d000b3a1d2e767966385203
-  data.tar.gz: 648d57e16f2ded50b0d62f966a3c59464032cf3d93d6502699b476c99607ccb8639e9d6d45ff8bdef6d79e24605c59edb510fb91c5b22e28d12f65bffd3fba63
+  metadata.gz: 3e29cd58cef7d9a02caacc815d6db9fb8b5a4e3279c6b4530d4d7ee6851289b759539881aa2660020c00c9fd0085ba411853cabb442a32a048c52e8ddc084af6
+  data.tar.gz: 6eafb4634d7659680d1b99d305b95ed0e8e9ca46c05885c8a145d837018a88286219b1dc6c5572e97591d1b0d4056a2333648eea69403986cd649c096f662e10

data/.travis.yml

@@ -1,4 +1,11 @@
 sudo: false
+dist: bionic
 language: ruby
+cache: bundler
 rvm:
-  - 2.3.1
+  - 2.5.3
+  - 2.6.3
+before_install:
+  - gem update --system
+  - gem install bundler
+

data/CHANGELOG.md

@@ -1,3 +1,11 @@
+
+# 0.3.1
+- Fix for dry-configurable 0.11 config#update does not return self
+
+# 0.3.0
+- Updated to JSON api
+- Added http dependency
+
 # 0.2.0
 - Removed dependencies on happy_mapper and rest_client.
 - Removed RangeDenormalizer. ScheduledRanges will no longer include member and position attributes.

data/Gemfile

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

data/README.md

@@ -1,4 +1,5 @@
 # Aladtec
+[![Gem Version](https://badge.fury.io/rb/aladtec.svg)](https://badge.fury.io/rb/aladtec)
 [![Build Status](https://travis-ci.org/travisdahlke/aladtec.svg)](https://travis-ci.org/travisdahlke/aladtec)
 [![Inline docs](http://inch-ci.org/github/travisdahlke/aladtec.svg?branch=master)](http://inch-ci.org/github/travisdahlke/aladtec)
 
@@ -23,8 +24,8 @@ Or install it yourself as:
 Configure the gem with your credentials:
 
     Aladtec.configure do |config|
-      config.acc_key = ENV['ALADTEC_ACC_KEY']
-      config.acc_id = ENV['ALADTEC_ACC_ID']
+      config.client_id = ENV['ALADTEC_CLIENT_ID']
+      config.client_secret = ENV['ALADTEC_CLIENT_SECRET']
       config.endpoint = ENV['ALADTEC_ENDPOINT']
     end
 
@@ -35,12 +36,20 @@ Get members
 
 Get events
 
-    client.events(begin_date: Date.today)
+    client.events(begin_time: Time.now, end_time: Time.now + 60 * 60 * 24)
 
 Get schedules
 
     client.schedules
 
+Get scheduled time ranges
+
+    client.scheduled_range(begin_time: Time.new(2019,10,1), end_time: Time.new(2019,10,31))
+
+Get members scheduled now
+
+    client.scheduled_now
+
 Refer to the [documentation](http://www.rubydoc.info/github/travisdahlke/aladtec) for more detailed usage.
 
 ## Contributing

data/Rakefile

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

data/aladtec.gemspec

@@ -1,28 +1,34 @@
-# coding: utf-8
-lib = File.expand_path('../lib', __FILE__)
+# frozen_string_literal: true
+
+lib = File.expand_path('lib', __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'aladtec/version'
 
 Gem::Specification.new do |spec|
-  spec.name          = "aladtec"
+  spec.name          = 'aladtec'
   spec.version       = Aladtec::VERSION
-  spec.authors       = ["Travis Dahlke"]
-  spec.email         = ["dahlke.travis@gmail.com"]
-  spec.summary       = %q{Client library for the Aladtec API}
-  spec.description   = %q{Retrieve schedules and events from the Aladtec API. Works with EMS Manager, Fire Manager, Zanager.}
-  spec.homepage      = ""
-  spec.license       = "MIT"
+  spec.authors       = ['Travis Dahlke']
+  spec.email         = ['dahlke.travis@gmail.com']
+  spec.summary       = 'Client library for the Aladtec API'
+  spec.description   = %(Retrieve schedules and events from the Aladtec API.
+     Works with EMS Manager, Fire Manager, Zanager. )
+  spec.homepage      = 'https://github.com/travisdahlke/aladtec'
+  spec.license       = 'MIT'
+
+  spec.required_ruby_version = '> 2.5'
 
   spec.files         = `git ls-files -z`.split("\x0")
   spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
-  spec.require_paths = ["lib"]
+  spec.require_paths = ['lib']
 
-  spec.add_development_dependency "bundler", "~> 1.5"
-  spec.add_development_dependency "rake"
-  spec.add_development_dependency "rspec"
-  spec.add_development_dependency "webmock"
-  spec.add_development_dependency "pry"
+  spec.add_development_dependency 'bundler', '~> 2.0'
+  spec.add_development_dependency 'pry'
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'rspec'
+  spec.add_development_dependency 'webmock'
 
-  spec.add_dependency "multi_xml"
+  spec.add_dependency 'dry-configurable', '~> 0.11', '>= 0.11.4'
+  spec.add_dependency 'dry-initializer'
+  spec.add_dependency 'http'
 end

data/lib/aladtec/client.rb

@@ -1,67 +1,75 @@
-require 'net/http'
-require 'multi_xml'
+# frozen_string_literal: true
+
+require 'http'
 require 'aladtec/event'
 require 'aladtec/member'
-require 'aladtec/authentication'
 require 'aladtec/range'
 require 'aladtec/schedule'
+require 'aladtec/scheduled_now'
 require 'aladtec/exceptions'
 
 module Aladtec
+  # Aladtec API Client
   class Client
+    attr_reader :config
+    def initialize(args = {})
+      @config = Aladtec.config.dup.tap do |c|
+        c.update(args)
+      end
+    end
 
+    def configure
+      yield config
+    end
 
-    attr_accessor *Configuration::VALID_CONFIG_KEYS
-
-    def initialize(options={})
-      merged_options = Aladtec.options.merge(options)
-
-      Configuration::VALID_CONFIG_KEYS.each do |key|
-        public_send("#{key}=", merged_options[key])
+    def authenticate
+      if config.client_id.nil? || config.client_secret.nil? 
+        raise Aladtec::Error, 'client_id and client_secret are required'
       end
+      body = { grant_type: 'client_credentials', client_id: config.client_id,
+               client_secret: config.client_secret }
+      response = HTTP.post(URI.join(config.endpoint, 'oauth/token'), json: body)
+      body = response.parse
+      @auth_token = body.fetch('token')
+      @auth_expiration = Time.at body.fetch('expires')
+      response.status.success?
     end
 
     # Public: Get a list of events for a date or range of dates
     #
     # options - The Hash options used to refine the selection (default: {}):
-    #           :begin_date - The begin date to return events for (required).
-    #           :end_date   - The end date to return events for (optional).
+    #           :begin_time - The begin date to return events for (required).
+    #           :end_time   - The end date to return events for (required).
     def events(options = {})
-      bd = options.fetch(:begin_date) { raise ArgumentError, "You must supply a :begin_date option!"}
-      ed = options.fetch(:end_date, nil)
-      bd = bd.is_a?(Date) ? bd.iso8601 : Date.parse(bd).iso8601
-      if ed
-        ed = ed.is_a?(Date) ? ed.iso8601 : Date.parse(ed).iso8601
+      bd = options.fetch(:begin_time) do
+        raise ArgumentError, 'You must supply a :begin_time option!'
+      end
+      ed = options.fetch(:end_time) do
+        raise ArgumentError, 'You must supply a :end_time option!'
       end
-      body = request(:getEvents, bd: bd, ed: ed)
-      fetch_map(body, "events", "event", Event)
+      events = request('events', range_start: format_time(bd),
+                                 range_stop: format_time(ed))
+      events.values.flatten.map { |event| Event.new(event) }
     end
 
     # Public: Get a list of members
     #
     def members
-      body = request(:getMembers, ia: 'all')
-      fetch_map(body, "members", "member", Member)
-    end
-
-    # Public: Authenticate member
-    #
-    def auth(username, password)
-      body = request(:authenticateMember, memun: username, mempw: password)
-      Authentication.new(body["results"]["authentication"])
+      res = request('members', include_attributes: true)
+      res.map { |member| Member.new(member) }
     end
 
     # Public: Get a list of schedules
     #
     def schedules
-      body = request(:getSchedules, isp: 1)
-      fetch_map(body, "schedules", "schedule", Schedule)
+      res = request('schedules')
+      res.map { |schedule| Schedule.new(schedule) }
     end
 
     # Public: Get list of members scheduled now
     def scheduled_now(options = {})
-      body = request(:getScheduledTimeNow, {isp: 1}.merge(options))
-      fetch_map(body, "schedules", "schedule", Schedule)
+      res = request('scheduled-time/members-scheduled-now', options)
+      res.map { |schedule| ScheduledNow.new(schedule) }
     end
 
     # Public: Get list of members scheduled in a time range
@@ -69,61 +77,38 @@ module Aladtec
     # options - The Hash options used to refine the selection (default: {}):
     #           :begin_time - The begin time to return events for (required).
     #           :end_time   - The end time to return events for (required).
-    #           :sch        - Array of schedule ids to fetch
     def scheduled_range(options = {})
-      bt = options.fetch(:begin_time) { raise ArgumentError, "You must supply a :begin_time!"}
-      et = options.fetch(:end_time) { raise ArgumentError, "You must supply an :end_time!"}
-      sch = Array(options.fetch(:sch, "all")).join(",")
-      bt = bt.is_a?(Time) ? bt.clone.utc.iso8601 : Time.parse(bt).utc.iso8601
-      et = et.is_a?(Time) ? et.clone.utc.iso8601 : Time.parse(et).utc.iso8601
-      body = request(:getScheduledTimeRanges, bt: bt, et: et, isp: 1, sch: sch)
-      fetch_map(body, "ranges", "range", Range)
-    end
-
-    def fetch_map(body, collection, key, klass)
-      results = body["results"][collection][key] if body["results"][collection]
-      return [] unless results
-      # Array.wrap
-      results = results.respond_to?(:to_ary) ? results.to_ary : [results]
-      results.map{|r| klass.new(r)}
-    end
-    private :fetch_map
-
-    def auth_params
-      {accid: acc_id, acckey: acc_key}
+      bt = options.fetch(:begin_time) do
+        raise ArgumentError, 'You must supply a :begin_time!'
+      end
+      et = options.fetch(:end_time) do
+        raise ArgumentError, 'You must supply an :end_time!'
+      end
+      scheduled_time = request('scheduled-time', range_start: format_time(bt),
+                                                 range_stop: format_time(et))
+      scheduled_time.values.flatten.map { |range| Range.new(range) }
     end
-    private :auth_params
 
-    def request(cmd, options = {})
-      post_params = options.merge(cmd: cmd)
-      req = Net::HTTP::Post.new(uri)
-      req.set_form_data(auth_params.merge(post_params))
-      req['User-Agent'] = user_agent
-      req['Accept'] = 'application/xml'
+    private
 
-      res = Net::HTTP.start(uri.hostname, uri.port, :use_ssl => uri.scheme == 'https') do |http|
-        http.use_ssl = true
-        http.request(req)
+    def request(path, options = {})
+      if auth_expired? && !authenticate
+        raise Aladtec::Error, 'authentication failed'
       end
+      res = HTTP[user_agent: config.user_agent]
+            .auth("Bearer #{@auth_token}")
+            .get(URI.join(config.endpoint, path), params: options)
+      raise Aladtec::Error, res.status.reason unless res.status.success?
 
-      case res
-      when Net::HTTPSuccess, Net::HTTPRedirection
-        body = MultiXml.parse(res.body)
-        if body["results"]["errors"]
-          raise Aladtec::Error, body["results"]["errors"]["error"]["__content__"]
-        else
-          return body
-        end
-      else
-        raise Aladtec::Error, res.msg
-      end
+      res.parse
     end
-    private :request
 
-    def uri
-      @uri ||= URI(endpoint)
+    def format_time(time)
+      (time.is_a?(Time) ? time : Time.parse(time)).strftime('%FT%R')
     end
-    private :uri
 
+    def auth_expired?
+      !@auth_token || !@auth_expiration || Time.now >= @auth_expiration
+    end
   end
 end

data/lib/aladtec/event.rb

@@ -1,13 +1,21 @@
+# frozen_string_literal: true
+
+require 'dry-initializer'
+
 module Aladtec
+  # Event
   class Event
-    attr_accessor :title, :description, :location, :begin, :end
-
-    def initialize(args = {})
-      @title = args["title"]
-      @description = args["description"]
-      @location = args["location"]
-      @begin = Time.parse(args["begin"]) if args["begin"]
-      @end = Time.parse(args["end"]) if args["end"]
+    extend Dry::Initializer
+
+    option :event_id, as: :id
+    option :title
+    option :description
+    option :location
+    option :start_datetime, Time.method(:parse), as: :starts_at
+    option :stop_datetime, Time.method(:parse), as: :ends_at, optional: true
+
+    def self.new(params)
+      super **params.transform_keys(&:to_sym)
     end
   end
 end

data/lib/aladtec/exceptions.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Aladtec
   class Error < StandardError; end
 end

data/lib/aladtec/member.rb

@@ -1,10 +1,22 @@
+# frozen_string_literal: true
+
+require 'dry-initializer'
+
 module Aladtec
+  # Member
   class Member
-    attr_accessor :id, :name
+    extend Dry::Initializer
+
+    option :member_id, as: :id
+    option :name
+    option :is_active
+    option :attributes, [] do
+      option :attribute_id, as: :id
+      option :value
+    end
 
-    def initialize(args = {})
-      @id = args["id"].to_i
-      @name = args["name"]
+    def self.new(params)
+      super **params.transform_keys(&:to_sym)
     end
   end
 end

data/lib/aladtec/position.rb

@@ -1,13 +1,18 @@
-require 'aladtec/member'
+# frozen_string_literal: true
+
+require 'dry-initializer'
 
 module Aladtec
+  # Position
   class Position
-    attr_accessor :id, :name, :member
+    extend Dry::Initializer
+
+    option :position_id, as: :id
+    option :label
+    option :member_id, optional: true
 
-    def initialize(args = {})
-      @id = args["id"].to_i
-      @name = args["name"]
-      @member = Member.new(args["member"]) if args["member"]
+    def self.new(params)
+      super **params.transform_keys(&:to_sym)
     end
   end
 end

data/lib/aladtec/range.rb

@@ -1,18 +1,22 @@
-require 'aladtec/schedule'
-require 'aladtec/position'
-require 'aladtec/member'
+# frozen_string_literal: true
+
+require 'dry-initializer'
 
 module Aladtec
+  # Range
   class Range
-    attr_accessor :schedule, :position, :member, :begin, :end
+    extend Dry::Initializer
 
-    def initialize(args = {})
-      @member = Member.new(args["member"])
-      @position = Position.new(args["position"])
-      @schedule = Schedule.new(args["schedule"])
-      @begin = Time.parse(args["begin"]) if args["begin"]
-      @end = Time.parse(args["end"]) if args["end"]
-    end
+    option :schedule_id
+    option :position_id
+    option :member_id
+    option :start_datetime, Time.method(:parse), as: :starts_at
+    option :stop_datetime, Time.method(:parse), as: :ends_at
+    option :extends_before
+    option :extends_after
 
+    def self.new(params)
+      super **params.transform_keys(&:to_sym)
+    end
   end
 end

data/lib/aladtec/schedule.rb

@@ -1,22 +1,21 @@
-require 'aladtec/position'
+# frozen_string_literal: true
+
+require 'dry-initializer'
 
 module Aladtec
+  # Schedule
   class Schedule
-    attr_accessor :id, :name, :positions
+    extend Dry::Initializer
 
-    def initialize(args = {})
-      @id = args["id"].to_i
-      @name = args["name"]
-      @positions = parse_positions(args["positions"]["position"]) if args["positions"]
+    option :schedule_id, as: :id
+    option :name
+    option :positions, [] do
+      option :position_id, proc(&:to_i), as: :id
+      option :label
     end
 
-    private
-
-    def parse_positions(positions)
-      return [] unless positions
-      return [Position.new(positions)] if positions.include? "id"
-      positions.map{|p| Position.new(p)}
+    def self.new(params)
+      super **params.transform_keys(&:to_sym)
     end
-
   end
 end

data/lib/aladtec/scheduled_now.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+require 'dry-initializer'
+
+module Aladtec
+  # ScheduledNow
+  class ScheduledNow
+    extend Dry::Initializer
+
+    option :schedule_id, as: :id
+    option :positions, [] do
+      option :position_id, proc(&:to_i), as: :id
+      option :member_id, proc(&:to_i)
+    end
+
+    def self.new(params)
+      super **params.transform_keys(&:to_sym)
+    end
+  end
+end

data/lib/aladtec/version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Aladtec
-  VERSION = "0.2.0"
+  VERSION = '0.3.2'
 end

data/lib/aladtec.rb

@@ -1,7 +1,15 @@
-require "aladtec/version"
-require "aladtec/configuration"
-require "aladtec/client"
+# frozen_string_literal: true
 
+require 'dry/configurable'
+require 'aladtec/version'
+require 'aladtec/client'
+
+# Aladtec API Wrapper
 module Aladtec
-  extend Configuration
+  extend Dry::Configurable
+
+  setting :endpoint, default: 'https://secure.aladtec.com/example/api/'
+  setting :user_agent, default: "Aladtec API Ruby Gem #{Aladtec::VERSION}"
+  setting :client_id
+  setting :client_secret
 end

data/spec/aladtec/aladtec_spec.rb

@@ -1,7 +1,24 @@
-require_relative File.join('..','spec_helper')
+# frozen_string_literal: true
+
+require_relative File.join('..', 'spec_helper')
 
 describe Aladtec do
   it 'should have a version' do
     expect(Aladtec::VERSION).not_to be_nil
   end
+
+  describe '.configure' do
+    Aladtec.settings.each do |key|
+      it "should set the #{key}" do
+        Aladtec.configure do |config|
+          config.public_send("#{key}=", key)
+        end
+        expect(Aladtec.config.public_send(key)).to eq(key)
+      end
+    end
+
+    after(:each) do
+      Aladtec.reset_config
+    end
+  end
 end