alma 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9e55ff048167a0ab10d80f1480ba2b18cc9fdb10
-  data.tar.gz: 87f0c5b9c23ac7a7c3c5927866f6f204db71656b
+  metadata.gz: 205918f513cfea340ea21733aebf97f9028a87ac
+  data.tar.gz: c8e0ada2ffcdd3cd1742bf076be8ee8416ec9c76
 SHA512:
-  metadata.gz: f047816c46187fc7ed8521156cfe4b5be6aa192f6fa1f67bf68f2330ec8a206d1423ace8d9232eabb7bc496f9472d1cfc89a1289f14aa67445d533949f02f603
-  data.tar.gz: 5912e6b39e09e6c6f5b29ac70e8223eaf1b2a343524b2f7a774641c63c452e63e8bf55b14ec4e2c6d2ec26eaeeffb469a4006562b24373b55bd13b4164981e5b
+  metadata.gz: b1e361f47c0f0b3feebf760111b3760ff7891aec3b040a697a79bbe827d5464a23d763350f04f14593c242bda1169713ff4a36d43140a6658969e8a5af7b8c97
+  data.tar.gz: 12b24d9df96c5c796324e4f3fee471883f77fd78079402e740b04b25a466d4fc2fa609fb7ef31ecb2ad7273af0517faa8739ac1881ec5fd6ae0f2985f5881522

data/README.md

@@ -38,7 +38,7 @@ Now you can access those configuration attributes with `Alma.configuration.apike
 ### Making Requests
 
 #### Get a list of Users
- ```ruby
+```ruby
  users = Alma::User.find
  
  users.total count
@@ -46,10 +46,10 @@ Now you can access those configuration attributes with `Alma.configuration.apike
  
  users.list.first.id 
  > 123456789
- ```
+```
  
 #### Get a Single user
- ```ruby
+```ruby
  user = Alma::User.find({:user_id => 123456789})
  
  user.first_name
@@ -57,30 +57,97 @@ Now you can access those configuration attributes with `Alma.configuration.apike
  
  user.email
  > chad.nelson@fictional.edu
- ```
+```
  
- Once you have a user, you can also request that users loans, fines, requests.
+#### Get details on a users fines
  
- ```ruby
+```ruby
  fines = user.fines
  fines.sum
- > 20.0
+ > "20.0"
+ 
+ fines.total_record_count
+ > "2"
+ 
+ fines.list
+ > [#<Alma::AlmaRecord:0x000000038b7b50
+    ...>,
+    #<Alma::AlmaRecord:0x000000038b7b28
+     ...>]
  
  fines.list.first.title
- > Practical Object Oriented Design with Ruby
+ > "Practical Object Oriented Design with Ruby"
+ 
+```
+
+#### Get details on a users loans
+ 
+```ruby
+loans = user.loans
+
+loans.total_record_count
+> "2"
+ 
+loans.list
+> [#<Alma::Loan:0x000000038c6b79
+  ...>,
+  #<Alma::Loan:0x000000038c6b34
+   ...>]
+ 
+loans.list.first.title
+ > "Javascript: The Good Parts"
+ 
+loans.list.first.due_date
+"2016-12-26z
+ 
+```
+
+To renew an item you can can call the Loan objects renew method
+
+```ruby
+renewal = loans.list.first.renew
+
+renewal.renewed?
+> True
+
+renewal.message 
+> "Javascript: The Good Parts is now due 02-20-17"
+
+```
+
+
+
+#### Get details on a users requests
+```ruby
+requests = user.requests
+
+requests.total_record_count
+> "1"
  
- user.loans.list
- [\<Item Object 1\>, \<Item Oject 2\>]
- ```
+requests.list
+> [#<Alma::AlmaRecord:0x000000038c6b79...>]
+ 
+requests.list.first.title
+> "Food in history / Reay Tannahill."
+
+requests.list.first.pickup_location
+> "Main Library"
+
+requests.list.first.request_status
+> "In Process"
+ 
+```
  
  Loans, fines and Requests can also be accessed statically
   
-  ```ruby
- fines = Alma::User.get_fines({:user_id => 123456789})
+```ruby
+Alma::User.get_fines({:user_id => 123456789})
  
- loans = Alma::User.get_loans({:user_id => 123456789})
+Alma::User.get_loans({:user_id => 123456789})
+
+Alma::User.get_requests({:user_id => 123456789})
  
- ```
+```
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.

data/lib/alma.rb

@@ -3,12 +3,14 @@ require 'alma/config'
 require 'alma/api'
 require 'alma/alma_record'
 require 'alma/user'
+require 'alma/loan'
 require 'alma/result_set'
 require 'alma/loan_set'
 require 'alma/user_set'
 require 'alma/fine_set'
 require 'alma/user_set'
 require 'alma/request_set'
+require 'alma/renewal_response'
 
 module Alma
 

data/lib/alma/loan.rb

@@ -0,0 +1,9 @@
+module Alma
+  class Loan < AlmaRecord
+
+    def renew
+      Alma::User.renew_loan({user_id: user_id, loan: self})
+    end
+
+  end
+end

data/lib/alma/loan_set.rb

@@ -5,7 +5,7 @@ module Alma
 
     def initialize(ws_response)
       @ws_response = ws_response
-      @total_record_count = ws_response.fetch(total_record_count, 0)
+      @total_record_count = ws_response.fetch('total_record_count', 0)
       @list ||= list_results
     end
 
@@ -15,9 +15,9 @@ module Alma
 
     def list_results
       response_records.map do |loan|
-        Alma::AlmaRecord.new(loan)
+        Alma::Loan.new(loan)
       end
     end
 
   end
-end
+end

data/lib/alma/renewal_response.rb

@@ -0,0 +1,39 @@
+module Alma
+  class RenewalResponse
+
+    def initialize(response, loan=nil)
+      @loan     = loan
+      @success  = response.fetch('item_loan', nil)
+      @error    = response.fetch('web_service_result', nil)
+      @renewed  = @error.nil?
+    end
+
+    def renewed?
+      @renewed
+    end
+
+    def new_due_date
+      Time.parse(@success['due_date']).strftime('%m-%e-%y %H:%M')
+    end
+
+    def error_message
+      @error['errorList']['error']['errorMessage']
+    end
+
+    def item_title
+      if @loan
+        @loan.title
+      else
+        "This Item"
+      end
+    end
+
+    def message
+      if @success
+        "#{item_title} is now due #{new_due_date}"
+      else
+        "#{item_title} could not be renewed."
+      end
+    end
+  end
+end

data/lib/alma/user.rb

@@ -7,19 +7,34 @@ module Alma
     attr_accessor :id
 
     def post_initialize
-      @id = response['primary_id']
+      @id = response['primary_id'].to_s
+      @recheck_loans = true
     end
 
     def fines
-      Alma::User.get_fines({:user_id => self.id.to_s})
+      self.class.get_fines({user_id: self.id})
     end
 
     def loans
-      Alma::User.get_loans({:user_id => self.id.to_s})
+      unless @loans && !recheck_loans?
+        @loans = self.class.get_loans({user_id: self.id})
+        @recheck_loans = false
+      end
+      @loans
+    end
+
+    def renew_loan(loan)
+      response = self.class.renew_loan({user_id: self.id, loan: loan})
+      @recheck_loans = true if response.renewed?
+      response
+    end
+
+    def recheck_loans?
+      @recheck_loans
     end
 
     def requests
-      Alma::User.get_requests({:user_id => self.id.to_s})
+      self.class.get_requests({user_id:self.id})
     end
 
     class << self
@@ -30,7 +45,7 @@ module Alma
         #TODO Handle Pagination
         #TODO Handle looping through all results
 
-        return find_by_id(:user_id => args[:user_id]) if args.fetch(:user_id, nil)
+        return find_by_id(user_id: args[:user_id]) if args.fetch(:user_id, nil)
         params = query_merge args
         response = resources.almaws_v1_users.get(params)
         Alma::UserSet.new(response)
@@ -77,6 +92,26 @@ module Alma
         response.code == 204
       end
 
+      # Attempts to renew a single item for a user
+      # @param [Hash] args
+      # @option args [String] :user_id The unique id of the user
+      # @option args [String] :loan_id The unique id of the loan - optional (either :loan_id or :loan must be present)
+      # @option args [String] :loan_id A loan object - optional (either :loan_id or :loan must be present)
+      # @option args [String] :user_id_type Type of identifier being used to search
+      # @return [RenewalResponse] Object indicating the renewal message
+      def renew_loan(args)
+        args.merge!({op: 'renew'})
+
+        # If a loan object is passed in args, us its id as loan_id
+        loan = args.delete(:loan)
+        if loan
+          args[:loan_id] = loan.loan_id
+        end
+        params = query_merge args
+        response = resources.almaws_v1_users.user_id_loans_loan_id.post(params)
+        RenewalResponse.new(response, loan)
+      end
+
 
       def set_wadl_filename
         'user.wadl'

data/lib/alma/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: alma
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Chad Nelson
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-01-18 00:00:00.000000000 Z
+date: 2017-01-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ezwadl
@@ -119,7 +119,9 @@ files:
 - lib/alma/api.rb
 - lib/alma/config.rb
 - lib/alma/fine_set.rb
+- lib/alma/loan.rb
 - lib/alma/loan_set.rb
+- lib/alma/renewal_response.rb
 - lib/alma/request_set.rb
 - lib/alma/result_set.rb
 - lib/alma/user.rb