aladtec 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4559364e023c7c4a781ecc7463901b10256bf125
-  data.tar.gz: fee96a2725c63d0b50b0251442e7be614e1b1791
+  metadata.gz: 5833472c1eeb7a7f359005a98ba355d114fb8223
+  data.tar.gz: 969f3e879943297a501a15253cece2cefbb7facb
 SHA512:
-  metadata.gz: d7487b455740cf72952d88ac0da3998d5523e36caf86a9d5fd0dbc212ae6f6215ea1007d29c1d19fac8efb74611a53fa93780308117c05527411b064a628aa89
-  data.tar.gz: 2d003cffb72914e92712dbc08990ae19d4a71f55155032aa3602296b4f1f4151cb7485264086596466d0049cd124698187d445a34ff6983c4f89f815ba29e426
+  metadata.gz: afdf0a35e2d5e5960a4958b41044ef0f5a7eb1c6484ccac93d8786ac7c7b6f2b910f3b8cf52f49e73b7d687de4c86b73522911748d000b3a1d2e767966385203
+  data.tar.gz: 648d57e16f2ded50b0d62f966a3c59464032cf3d93d6502699b476c99607ccb8639e9d6d45ff8bdef6d79e24605c59edb510fb91c5b22e28d12f65bffd3fba63

data/.travis.yml

@@ -1,6 +1,4 @@
 sudo: false
 language: ruby
 rvm:
-  - 2.1.0
-  - 2.0.0
-  - 1.9.3
+  - 2.3.1

data/CHANGELOG.md

@@ -0,0 +1,3 @@
+# 0.2.0
+- Removed dependencies on happy_mapper and rest_client.
+- Removed RangeDenormalizer. ScheduledRanges will no longer include member and position attributes.

data/README.md

@@ -29,13 +29,16 @@ Configure the gem with your credentials:
     end
 
 Get members
+
     client = Aladtec::Client.new
     client.members
 
 Get events
+
     client.events(begin_date: Date.today)
 
 Get schedules
+
     client.schedules
 
 Refer to the [documentation](http://www.rubydoc.info/github/travisdahlke/aladtec) for more detailed usage.

data/aladtec.gemspec

@@ -24,6 +24,5 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "webmock"
   spec.add_development_dependency "pry"
 
-  spec.add_dependency "rest-client", "~> 1.6.7"
-  spec.add_dependency "happymapper", "~> 0.4.1"
+  spec.add_dependency "multi_xml"
 end

data/lib/aladtec/authentication.rb

@@ -1,14 +1,13 @@
-require 'happymapper'
-
 module Aladtec
   class Authentication
-    include HappyMapper
+    attr_accessor :code, :retry, :message, :member
 
-    tag 'authentication'
-    attribute :code, Integer
-    attribute :retry, Integer
-    element :message, String
-    has_one :member, Member
+    def initialize(args = {})
+      @code = args["code"].to_i
+      @retry = args["retry"]
+      @message = args["message"]
+      @member = args["member"]
+    end
 
     def success?
       self.code == 0

data/lib/aladtec/client.rb

@@ -1,15 +1,16 @@
-require 'kconv'
-require 'rest-client'
+require 'net/http'
+require 'multi_xml'
 require 'aladtec/event'
 require 'aladtec/member'
 require 'aladtec/authentication'
 require 'aladtec/range'
 require 'aladtec/schedule'
-require 'aladtec/range_denormalizer'
+require 'aladtec/exceptions'
 
 module Aladtec
   class Client
 
+
     attr_accessor *Configuration::VALID_CONFIG_KEYS
 
     def initialize(options={})
@@ -26,43 +27,41 @@ module Aladtec
     #           :begin_date - The begin date to return events for (required).
     #           :end_date   - The end date to return events for (optional).
     def events(options = {})
-      bd = options.fetch(:begin_date) { raise "You must supply a :begin_date option!"}
+      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
       end
-      response = request(:getEvents, bd: bd, ed: ed)
-      Event.parse(response.body)
-    rescue LibXML::XML::Error
-      Event.parse(Kconv.toutf8(response.body))
+      body = request(:getEvents, bd: bd, ed: ed)
+      fetch_map(body, "events", "event", Event)
     end
 
     # Public: Get a list of members
     #
     def members
-      response = request(:getMembers, ia: 'all')
-      Member.parse(response.body)
+      body = request(:getMembers, ia: 'all')
+      fetch_map(body, "members", "member", Member)
     end
 
     # Public: Authenticate member
     #
     def auth(username, password)
-      response = request(:authenticateMember, memun: username, mempw: password)
-      Authentication.parse(response.body)
+      body = request(:authenticateMember, memun: username, mempw: password)
+      Authentication.new(body["results"]["authentication"])
     end
 
     # Public: Get a list of schedules
     #
     def schedules
-      response = request(:getSchedules, isp: 1)
-      Schedule.parse(response.body)
+      body = request(:getSchedules, isp: 1)
+      fetch_map(body, "schedules", "schedule", Schedule)
     end
 
     # Public: Get list of members scheduled now
-    def scheduled_now
-      response = request(:getScheduledTimeNow, isp: 1)
-      Schedule.parse(response.body)
+    def scheduled_now(options = {})
+      body = request(:getScheduledTimeNow, {isp: 1}.merge(options))
+      fetch_map(body, "schedules", "schedule", Schedule)
     end
 
     # Public: Get list of members scheduled in a time range
@@ -70,18 +69,25 @@ 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 "You must supply a :begin_time!"}
-      et = options.fetch(:end_time) { raise "You must supply an :end_time!"}
+      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
-      response = request(:getScheduledTimeRanges, bt: bt, et: et, isp: 1)
-      denormalize_ranges(Range.parse(response.body))
+      body = request(:getScheduledTimeRanges, bt: bt, et: et, isp: 1, sch: sch)
+      fetch_map(body, "ranges", "range", Range)
     end
 
-    def denormalize_ranges(ranges, klass = RangeDenormalizer)
-      klass.new(schedules: schedules, members: members).denormalize(ranges)
+    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}
@@ -90,9 +96,34 @@ module Aladtec
 
     def request(cmd, options = {})
       post_params = options.merge(cmd: cmd)
-      RestClient.post(endpoint, auth_params.merge(post_params), user_agent: user_agent, accept: :xml)
+      req = Net::HTTP::Post.new(uri)
+      req.set_form_data(auth_params.merge(post_params))
+      req['User-Agent'] = user_agent
+      req['Accept'] = 'application/xml'
+
+      res = Net::HTTP.start(uri.hostname, uri.port, :use_ssl => uri.scheme == 'https') do |http|
+        http.use_ssl = true
+        http.request(req)
+      end
+
+      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
     end
     private :request
 
+    def uri
+      @uri ||= URI(endpoint)
+    end
+    private :uri
+
   end
 end

data/lib/aladtec/configuration.rb

@@ -4,7 +4,7 @@ module Aladtec
     VALID_OPTIONS_KEYS    = [:acc_id, :acc_key].freeze
     VALID_CONFIG_KEYS     = VALID_CONNECTION_KEYS + VALID_OPTIONS_KEYS
 
-    DEFAULT_ENDPOINT    = 'https://secure.emsmanager.net/api/index.php'
+    DEFAULT_ENDPOINT    = "https://secure.emsmanager.net/api/index.php".freeze
     DEFAULT_METHOD      = :post
     DEFAULT_USER_AGENT  = "Aladtec API Ruby Gem #{Aladtec::VERSION}".freeze
 

data/lib/aladtec/event.rb

@@ -1,14 +1,13 @@
-require 'happymapper'
-
 module Aladtec
   class Event
-    include HappyMapper
+    attr_accessor :title, :description, :location, :begin, :end
 
-    tag 'event'
-    element :title, String
-    element :description, String
-    element :location, String
-    element :begin, Time
-    element :end, Time
+    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"]
+    end
   end
 end

data/lib/aladtec/exceptions.rb

@@ -0,0 +1,3 @@
+module Aladtec
+  class Error < StandardError; end
+end

data/lib/aladtec/member.rb

@@ -1,11 +1,10 @@
-require 'happymapper'
-
 module Aladtec
   class Member
-    include HappyMapper
+    attr_accessor :id, :name
 
-    tag 'member'
-    attribute :id, Integer
-    element :name, String
+    def initialize(args = {})
+      @id = args["id"].to_i
+      @name = args["name"]
+    end
   end
 end

data/lib/aladtec/position.rb

@@ -1,13 +1,13 @@
-require 'happymapper'
 require 'aladtec/member'
 
 module Aladtec
   class Position
-    include HappyMapper
+    attr_accessor :id, :name, :member
 
-    tag 'position'
-    element :name, String
-    attribute :id, Integer
-    has_one :member, Member
+    def initialize(args = {})
+      @id = args["id"].to_i
+      @name = args["name"]
+      @member = Member.new(args["member"]) if args["member"]
+    end
   end
 end

data/lib/aladtec/range.rb

@@ -1,17 +1,18 @@
-require 'happymapper'
 require 'aladtec/schedule'
 require 'aladtec/position'
 require 'aladtec/member'
 
 module Aladtec
   class Range
-    include HappyMapper
+    attr_accessor :schedule, :position, :member, :begin, :end
+
+    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
 
-    tag 'range'
-    has_one :schedule, Schedule
-    has_one :position, Position
-    has_one :member, Member
-    element :begin, Time
-    element :end, Time
   end
 end

data/lib/aladtec/schedule.rb

@@ -1,13 +1,22 @@
-require 'happymapper'
 require 'aladtec/position'
 
 module Aladtec
   class Schedule
-    include HappyMapper
+    attr_accessor :id, :name, :positions
+
+    def initialize(args = {})
+      @id = args["id"].to_i
+      @name = args["name"]
+      @positions = parse_positions(args["positions"]["position"]) if args["positions"]
+    end
+
+    private
+
+    def parse_positions(positions)
+      return [] unless positions
+      return [Position.new(positions)] if positions.include? "id"
+      positions.map{|p| Position.new(p)}
+    end
 
-    tag 'schedule'
-    has_many :positions, Position
-    element :name, String
-    attribute :id, Integer
   end
 end

data/lib/aladtec/version.rb

@@ -1,3 +1,3 @@
 module Aladtec
-  VERSION = "0.1.0"
+  VERSION = "0.2.0"
 end

data/spec/aladtec/client_spec.rb

@@ -5,6 +5,20 @@ describe Aladtec::Client do
     Aladtec::Configuration::VALID_CONFIG_KEYS
   end
 
+  describe "#auth" do
+    let(:auth) { subject.auth("user", "pass") }
+    before(:each) do
+      stub_request(:post, "https://secure.emsmanager.net/api/index.php").
+              with(body: hash_including({cmd: "authenticateMember"})).
+              to_return(body: fixture('authenticate_member.xml'))
+    end
+
+    it "returns an authentication object" do
+      expect(auth).to be_success
+    end
+
+  end
+
   describe "#members" do
     let(:members) { subject.members }
     before(:each) do

data/spec/fixtures/authenticate_member.xml

@@ -0,0 +1,6 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<results version="3.5.1" accessTime="2016­03­03T15:52:01Z">
+  <authentication code="0">
+    <member id="8"/>
+  </authentication>
+</results>

data/spec/fixtures/get_schedules.xml

@@ -1 +1,57 @@
-<?xml version="1.0" encoding="UTF-8"?>
    <schedules>
        <schedule id="5">
            <name>Sample BLS - 24/48</name>
        </schedule>
        <schedule id="6">
            <name>Medic 5</name>
        </schedule>
        <schedule id="7">
            <name>Wheelchair Van 12</name>
        </schedule>
        <schedule id="8">
            <name>Air Crew</name>
        </schedule>
        <schedule id="9">
            <name>Dispatch</name>
        </schedule>
    </schedules>
+<?xml version="1.0" encoding="UTF-8"?>
+<results version="3.5.1" accessTime="2016­03­03T15:52:01Z">
+  <schedules>
+    <schedule id="5">
+      <name>Sample BLS - 24/48</name>
+      <positions>
+        <position id="1">
+          <name>EMT</name>
+        </position>
+        <position id="2">
+          <name>Driver</name>
+        </position>
+      </positions>
+    </schedule>
+    <schedule id="6">
+      <name>Medic 5</name>
+      <positions>
+        <position id="9">
+          <name>Medic</name>
+        </position>
+        <position id="8">
+          <name>EMT</name>
+        </position>
+      </positions>
+    </schedule>
+    <schedule id="7">
+      <name>Wheelchair Van 12</name>
+      <positions>
+        <position id="14">
+          <name>Driver</name>
+        </position>
+      </positions>
+    </schedule>
+    <schedule id="8">
+      <name>Air Crew</name>
+      <positions>
+        <position id="10">
+          <name>Medic</name>
+        </position>
+        <position id="11">
+          <name>EMT</name>
+        </position>
+        <position id="12">
+          <name>Pilot</name>
+        </position>
+      </positions>
+    </schedule>
+    <schedule id="9">
+      <name>Dispatch</name>
+      <positions>
+        <position id="4">
+          <name>Dispatcher</name>
+        </position>
+      </positions>
+    </schedule>
+  </schedules>
+</results>

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: aladtec
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Travis Dahlke
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-10-30 00:00:00.000000000 Z
+date: 2016-12-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -81,33 +81,19 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: rest-client
+  name: multi_xml
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 1.6.7
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 1.6.7
-- !ruby/object:Gem::Dependency
-  name: happymapper
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 0.4.1
+        version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 0.4.1
+        version: '0'
 description: Retrieve schedules and events from the Aladtec API. Works with EMS Manager,
   Fire Manager, Zanager.
 email:
@@ -118,6 +104,7 @@ extra_rdoc_files: []
 files:
 - ".gitignore"
 - ".travis.yml"
+- CHANGELOG.md
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -128,16 +115,16 @@ files:
 - lib/aladtec/client.rb
 - lib/aladtec/configuration.rb
 - lib/aladtec/event.rb
+- lib/aladtec/exceptions.rb
 - lib/aladtec/member.rb
 - lib/aladtec/position.rb
 - lib/aladtec/range.rb
-- lib/aladtec/range_denormalizer.rb
 - lib/aladtec/schedule.rb
 - lib/aladtec/version.rb
 - spec/aladtec/aladtec_spec.rb
 - spec/aladtec/client_spec.rb
 - spec/aladtec/configuration_spec.rb
-- spec/aladtec/range_denormalizer_spec.rb
+- spec/fixtures/authenticate_member.xml
 - spec/fixtures/get_events.xml
 - spec/fixtures/get_members.xml
 - spec/fixtures/get_scheduled_time_now.xml
@@ -164,7 +151,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5.1
+rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
 summary: Client library for the Aladtec API
@@ -172,7 +159,7 @@ test_files:
 - spec/aladtec/aladtec_spec.rb
 - spec/aladtec/client_spec.rb
 - spec/aladtec/configuration_spec.rb
-- spec/aladtec/range_denormalizer_spec.rb
+- spec/fixtures/authenticate_member.xml
 - spec/fixtures/get_events.xml
 - spec/fixtures/get_members.xml
 - spec/fixtures/get_scheduled_time_now.xml

data/lib/aladtec/range_denormalizer.rb

@@ -1,50 +0,0 @@
-module Aladtec
-  class RangeDenormalizer
-    attr_reader :members, :schedules
-
-    def initialize(attrs = {})
-      @members = attrs.fetch(:members) { raise "You must provide the members" }
-      @schedules = attrs.fetch(:schedules) { raise "You must provide the schedules" }
-    end
-
-    def denormalize(ranges)
-      ranges.each do |range|
-        find_member(range)
-        find_schedule(range)
-        find_position(range)
-        range.position = positions_by_id[range.position.id] || range.position
-      end
-    end
-
-    def find_member(range)
-      member = members_by_id[range.member.id]
-      range.member = member if member
-    end
-
-    def find_schedule(range)
-      schedule = schedules_by_id[range.schedule.id]
-      range.schedule = schedule if schedule
-    end
-
-    def find_position(range)
-      position = positions_by_id[range.position.id]
-      range.position = position if position
-    end
-
-    def members_by_id
-      @members_by_id ||= members.reduce({}) {|h, member| h[member.id] = member; h}
-    end
-
-    def schedules_by_id
-      @schedules_by_id ||= schedules.reduce({}) do |h, schedule|
-        h[schedule.id] = schedule
-        schedule.positions.each {|position| positions_by_id[position.id] ||= position}
-        h
-      end
-    end
-
-    def positions_by_id
-      @positions_by_id ||= {}
-    end
-  end
-end

data/spec/aladtec/range_denormalizer_spec.rb

@@ -1,26 +0,0 @@
-require_relative File.join('..','spec_helper')
-require 'ostruct'
-
-describe Aladtec::RangeDenormalizer do
-  let(:members) {[OpenStruct.new(id: 1, name: "Joe Schmoe"), OpenStruct.new(id: 2, name: "Ann Perkins")]}
-  let(:schedules) {
-    [OpenStruct.new(id: 1, name: "Daytime", positions: [OpenStruct.new(id: 3, name: "Firefighter")]),
-     OpenStruct.new(id: 2, name: "Nighttime", positions: [OpenStruct.new(id: 3, name: "Firefighter")])]
-  }
-  subject { Aladtec::RangeDenormalizer.new(members: members, schedules: schedules) }
-
-  describe "#denormalize" do
-    let(:ranges) {[OpenStruct.new(member: OpenStruct.new(id: 1), schedule: OpenStruct.new(id: 2), position: OpenStruct.new(id: 3))]}
-    it "should map members to ranges" do
-      expect(subject.denormalize(ranges).first.member.name).to eq("Joe Schmoe")
-    end
-
-    it "should map schedules to ranges" do
-      expect(subject.denormalize(ranges).first.schedule.name).to eq("Nighttime")
-    end
-
-    it "should map positions to ranges" do
-      expect(subject.denormalize(ranges).first.position.name).to eq("Firefighter")
-    end
-  end
-end