tessitura_rest 1.5.1 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1b0e73929476e5b0fb98733fb24cd87c99f80cf7e72b8f9836bcfbd43b5a3b93
-  data.tar.gz: 1ddde42fd7152c9b5465dce0c60da4c5b53d91d7cf864f3e23ca6aea53fd4173
+  metadata.gz: 7f7d53c0e30ab24ecb1292529c3e77f9e0ca53d1247d9434ab73e396b9ef8291
+  data.tar.gz: 76f6b654bd47108357ee2edd2cfd4bdf40247763fa1f688dbdc05b2b5b3cd27c
 SHA512:
-  metadata.gz: 7c57afbab08d149f2527c85ec8430787b943c38712e114a13df712e380b3da9c5327be15b7b0bff267695292e4488e8d706db782349d4197942f33fb6f8316dc
-  data.tar.gz: '05059ea32d3bbb55da3ec671332922a9f3d2472c95a045cae1890a96772ebe560c13e7787e5cafcce35ed7dc9cea6b65e24f928d2ce7c9219d9d18a2c78d6922'
+  metadata.gz: 3faf1d15c3bf233d61dc94a5a990f840df4978b5912cd7e928c08524b98783669bf3c2a27162ae13e748d877f3816be13f3a715d25e584309c02a693291ab7ff
+  data.tar.gz: afdca0d765b27d307271574880baef930e1e0b49f7fa95df9923ada1f2edf2802232218ffc05c047db98c83ca87c4b279303e324f7b7ff9ad21c4fa140c98935

data/.gitignore

@@ -8,4 +8,5 @@
 /spec/reports/
 /tmp/
 .env
+.env_enc
 .idea/

data/README.md

@@ -1,3 +1,6 @@
+[![Test Coverage](https://api.codeclimate.com/v1/badges/7e9be54ce754061ff52a/test_coverage)](https://codeclimate.com/repos/5a8308622f7e3e028700068f/test_coverage)
+[![Maintainability](https://api.codeclimate.com/v1/badges/7e9be54ce754061ff52a/maintainability)](https://codeclimate.com/repos/5a8308622f7e3e028700068f/maintainability)
+
 # TessituraRest
 
 A Ruby gem wrapper for the [TessituraRest Network's Rest API](https://www.tessituranetwork.com/) (version 14 and up).
@@ -11,77 +14,102 @@ gem 'tessitura_rest'
 ```
 
 And then execute:
+
 ```
 $ bundle
 ```
+
 Or install it yourself as:
+
 ```
 $ gem install tessitura_rest
 ```
+
 ## Usage
 
 Create a .env file in the root of your directory. The following fields are required:
 
-* TESSITURA_URL          # the url to your Production TessituraRest REST instance
-* TESSITURA_USERNAME     # the username to authenticate to your TessituraRest REST instance
-* TESSITURA_PASSWORD     # the password to authenticate to your TessituraRest REST instance    
+* TESSITURA_v16_URL # the url to your Production TessituraRest REST instance
+* TESSITURA_USERNAME # the username to authenticate to your TessituraRest REST instance
+* TESSITURA_PASSWORD # the password to authenticate to your TessituraRest REST instance
 
 To run the gem locally, use:
+
 ```
 $ rake console
 ```
+
 To connect to the TessituraRest Rest API, use:
+
 ```
 TessituraRest.new
 ```
-followed by the method and arguments you would like to use.     
+
+followed by the method and arguments you would like to use.
 
 ## Running the Test Suite
 
 1. You will need to add valid environment variables to the gem to run the test suite.
-2. Delete all of the pre-recorded cassettes tapes from spec/vcr_cassettes so they can be re-recorded with your instance's settings.
+2. Delete all of the pre-recorded cassettes tapes from spec/vcr_cassettes so they can be re-recorded with your
+   instance's settings.
 3. Create a .env file and set these values:
 
-* TESSITURA_URL          # the url to your Test/Staging TessituraRest REST instance
-* USERNAME               # the username to authenticate to your TessituraRest REST instance
-* PASSWORD               # the password to authenticate to your TessituraRest REST instance
-* WEB_CART_TEXT          # the ID to the pricing rule you have setup for Cart
-* SESSION_KEY            # an existing session key in your TessituraRest instance
-* EMAIL                  # an email tied to an existing web login in your TessituraRest instance
-* CONSTITUENT_ID         # an active constituent in your TessituraRest instance
-* ATTRIBUTE_ID           # an active Attribute in your TessituraRest instance
-* SCALPER_ID             # any active constituent in your TessituraRest instance
-* CSI_ID                 # the id of an open customer service inquiry in your TessituraRest instance
-* PATRON_ID              # the patron ID of a user whom submits CSIs
-* ACTION_ID              # the id of an action made against a customer service inquiry in your TessituraRest instance
-* ACTION_TYPE            # a valid action type that can be attributed to an action on a customer service inquiry
-* PROMO_CODE             # a valid integer tied to an active promotion code
-* PROMO_CODE_STRING      # a valid string tied to an active promotion code
-* FUND                   # an active fund to apply money to
-* FUND2                  # another active fund to apply money to
-* MEMBER                 # an active membership level
-* PAYMENT_ID             # active payment auth ID
-* GIFT_CARD_NO           # a valid gift certificate number that has been purchased
-* APPLIED_GC             # a valid gift certificate number that can be used to purchase products
-* RETURN_TICKET_KEY      # a logged in session that contains a exchangeable ticket
-* TEMPLATE_ID            # a valid email template ID to send Forgot Password emails
-* PROFILE_ID             # a valid email template profile ID
+* TESSITURA_URL # the url to your Test/Staging TessituraRest REST instance
+* USERNAME # the username to authenticate to your TessituraRest REST instance
+* PASSWORD # the password to authenticate to your TessituraRest REST instance
+* WEB_CART_TEXT # the ID to the pricing rule you have setup for Cart
+* SESSION_KEY # an existing session key in your TessituraRest instance
+* EMAIL # an email tied to an existing web login in your TessituraRest instance
+* CONSTITUENT_ID # an active constituent in your TessituraRest instance
+* ATTRIBUTE_ID # an active Attribute in your TessituraRest instance
+* SCALPER_ID # any active constituent in your TessituraRest instance
+* CSI_ID # the id of an open customer service inquiry in your TessituraRest instance
+* PATRON_ID # the patron ID of a user whom submits CSIs
+* ACTION_ID # the id of an action made against a customer service inquiry in your TessituraRest instance
+* ACTION_TYPE # a valid action type that can be attributed to an action on a customer service inquiry
+* PROMO_CODE # a valid integer tied to an active promotion code
+* PROMO_CODE_STRING # a valid string tied to an active promotion code
+* FUND # an active fund to apply money to
+* FUND2 # another active fund to apply money to
+* MEMBER # an active membership level
+* PAYMENT_ID # active payment auth ID
+* GIFT_CARD_NO # a valid gift certificate number that has been purchased
+* APPLIED_GC # a valid gift certificate number that can be used to purchase products
+* RETURN_TICKET_KEY # a logged in session that contains a exchangeable ticket
+* TEMPLATE_ID # a valid email template ID to send Forgot Password emails
+* PROFILE_ID # a valid email template profile ID
 
 To run the tests:
+
 ```
 $ rake spec
 ```
-WARNING: I advise you NOT to run the test suite against your Production TessituraRest API since it will make database alterations.
+
+WARNING: I advise you NOT to run the test suite against your Production TessituraRest API since it will make database
+alterations.
+
+## Updating CircleCI's Environment Variables
+
+1. Go to the CircleCI dashboard for the tessitura gem.
+2. Click on the gear icon in the upper right corner.
+3. Click on the tessitura gem project.
+4. Click on Environment Variables.
+5. Encode your .env with ```base64 -i .env -o .env_enc``` and add the encoded string to the ENV_ENC variable.
 
 ## 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.
+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.
 
-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).
+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/pgharts/tessitura. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+Bug reports and pull requests are welcome on GitHub at https://github.com/pgharts/tessitura. This project is intended to
+be a safe, welcoming space for collaboration, and contributors are expected to adhere to
+the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
 
 ## License
 

data/lib/tessitura_rest/crm/addresses.rb

@@ -22,7 +22,6 @@ module Addresses
           'Id': constituent,
         },
         'Inactive': false,
-        'Label': true,
         'Months': 'YYYYYYYYYYYY',
         'PostalCode': postal_code,
         'PrimaryIndicator': primary,
@@ -58,7 +57,6 @@ module Addresses
           'Id': current['Constituent']['Id'],
         },
         'Inactive': false,
-        'Label': true,
         'Months': 'YYYYYYYYYYYY',
         'PostalCode': postal_code,
         'PrimaryIndicator': primary,
@@ -94,7 +92,6 @@ module Addresses
           'Id': current['Constituent']['Id'],
         },
         'Inactive': true,
-        'Label': true,
         'Months': 'YYYYYYYYYYYY',
         'PostalCode': current['PostalCode'],
         'State': {

data/lib/tessitura_rest/crm/constituencies.rb

@@ -17,6 +17,6 @@ module Constituencies
       }
     options.merge!(basic_auth: @auth, headers: @headers)
     options.merge!(:body => parameters.to_json)
-    response = self.class.post(base_api_endpoint('CRM/Constituencies'), options)
+    self.class.post(base_api_endpoint('CRM/Constituencies'), options)
   end
 end

data/lib/tessitura_rest/crm/constituents.rb

@@ -60,6 +60,55 @@ module Constituents
     self.class.post(base_api_endpoint('CRM/Constituents/Snapshot'), options)
   end
 
+  def create_constituent_by_snapshot_v16(first_name, last_name, email, phone, constituent_type, source, street1, street2, city, state, zip, country, options = {})
+    parameters =
+      {
+        'ConstituentType': {
+          'Id': constituent_type,
+        },
+        'FirstName': first_name,
+        'LastName': last_name,
+        'OriginalSource': {
+          'Id': source,
+        },
+        'PrimaryAddress': {
+          'AddressType': {
+            'Id': 3,
+          },
+          'City': city,
+          'PostalCode': zip,
+          'State': {
+            'Id': state,
+          },
+          'Street1': street1,
+          'Street2': street2,
+          'Country': {
+            'Id': country,
+          },
+        },
+        'PrimaryElectronicAddress': {
+          'Address': email,
+          'ElectronicAddressType': {
+            'Id': 1,
+          },
+          'AllowHtmlFormat': true,
+          'Inactive': false,
+          'AllowMarketing': false,
+          'Months': 'YYYYYYYYYYYY',
+          'PrimaryIndicator': true,
+          'PrimaryPhone': {
+            'PhoneNumber': phone,
+            'PhoneType': {
+              'Id': 5,
+            },
+          },
+        },
+      }
+    options.merge!(basic_auth: @auth, headers: @headers)
+    options.merge!(:body => parameters.to_json)
+    self.class.post(base_api_endpoint('CRM/Constituents/Snapshot'), options)
+  end
+
   def update_constituent(constituent_id, params, options = {})
     current = get_constituent_snapshot(constituent_id)
     if is_household?(current)

data/lib/tessitura_rest/finance/appeals.rb

@@ -1,6 +1,6 @@
 module Appeals
   def get_appeal_info(appeal_id, options = {})
     options.merge!(basic_auth: @auth, headers: @headers)
-    response = self.class.get(base_api_endpoint("Finance/Appeals/#{appeal_id}"), options)
+    self.class.get(base_api_endpoint("Finance/Appeals/#{appeal_id}"), options)
   end
 end

data/lib/tessitura_rest/txn/package.rb

@@ -14,6 +14,7 @@ module Package
     options.merge!(basic_auth: @auth, headers: @headers)
     options.merge!(:body => parameters.to_json)
     response = self.class.post(base_api_endpoint('TXN/Packages/Search'), options)
+    JSON.parse(response.body)
   end
 
   def get_package_detail(id, mode_of_sale, options = {})

data/lib/tessitura_rest/txn/performance_extension.rb

@@ -13,8 +13,7 @@ module PerformanceExtension
 
   def get_performance_summaries(production_season_id, performance_ids = nil, season_ids = nil, options = {})
     options.merge!(basic_auth: @auth, headers: @headers)
-    response = self.class.get(base_api_endpoint("/TXN/Performances/Summary?performanceIds=#{performance_ids}&seasonIds=#{season_ids}&productionSeasonId=#{production_season_id}"),
-                              options)
+    response = self.class.get(base_api_endpoint("TXN/Performances/Summary?performanceIds=#{performance_ids}&seasonIds=#{season_ids}&productionSeasonId=#{production_season_id}"), options)
     JSON.parse(response.body)
   end
 
@@ -44,22 +43,18 @@ module PerformanceExtension
 
   def get_performance_seat_summaries(id, mode_of_sale, constituent_id, price_type_ids, options = {})
     options.merge!(basic_auth: @auth, headers: @headers)
-    response = self.class.get(
-      base_api_endpoint("TXN/Performances/#{id}/Seats/Summary?modeOfSaleId=#{mode_of_sale}&constituentId=#{constituent_id}&checkPriceTypeIds=#{price_type_ids}"), options
-    )
+    response = self.class.get(base_api_endpoint("TXN/Performances/#{id}/Seats/Summary?modeOfSaleId=#{mode_of_sale}&constituentId=#{constituent_id}&checkPriceTypeIds=#{price_type_ids}"), options)
     JSON.parse(response.body)
   end
 
   def get_performance_prices(id, mos, source, options = {})
     options.merge!(basic_auth: @auth, headers: @headers)
-    options.merge!(:headers => { 'Content-Type' => 'application/json' })
     response = self.class.get(base_api_endpoint("TXN/Performances/Prices?performanceIds=#{id}&modeOfSaleId=#{mos}&sourceId=#{source}"), options)
     JSON.parse(response.body)
   end
 
   def get_seat_holds(id, hold_code_ids, options = {})
     options.merge!(basic_auth: @auth, headers: @headers)
-    options.merge!(:headers => { 'Content-Type' => 'application/json' })
     response = self.class.get(base_api_endpoint("TXN/Performances/#{id}/Seats/Holds?holdCodeIds=#{hold_code_ids}"), options)
     JSON.parse(response.body)
   end

data/lib/tessitura_rest/version.rb

@@ -1,3 +1,3 @@
 class TessituraRest
-  VERSION = '1.5.1'.freeze
+  VERSION = '2.0.0'.freeze
 end

data/lib/tessitura_rest/web/cart.rb

@@ -58,7 +58,7 @@ module Cart
     self.class.delete(base_api_endpoint("Web/Cart/#{session_key}/Payments/GiftCertificate/#{gift_certificate_number}"), options)
   end
 
-  def add_contribution(session_key, amount, fund, membership_level, renew = nil, upgrade = nil, options = {})
+  def add_contribution(session_key, amount, fund, membership_level, renew = false, upgrade = false, options = {})
     parameters =
       {
         'Amount': amount,

data/lib/tessitura_rest/web/login.rb

@@ -12,7 +12,6 @@ module Login
         'Password': password,
         'LoginTypeId': login_type_id,
         'PromotionCode': promotion,
-        'PersistSessionOnFailure': true,
       }
     options.merge!(basic_auth: @auth, headers: @headers)
     options.merge!(:body => parameters.to_json)
@@ -47,7 +46,7 @@ module Login
     post.success?
   end
 
-  def login_as_guest(email, key, options = {})
+  def login_as_guest(email, session_key, options = {})
     # promotion will be added as a parameter in v 16.0
     parameters =
       {
@@ -57,13 +56,12 @@ module Login
       }
     options.merge!(basic_auth: @auth, headers: @headers)
     options.merge!(body: parameters.to_json)
-    response = self.class.post(base_api_endpoint("Web/Session/#{key}/LoginAsGuest"), options)
+    response = self.class.post(base_api_endpoint("Web/Session/#{session_key}/LoginAsGuest"), options)
     JSON.parse(response.body)
   end
 
   def logout(session_key, options = {})
     options.merge!(basic_auth: @auth, headers: @headers)
-    options.merge!(:body => {})
-    self.class.post(base_api_endpoint("/Web/Session/#{session_key}/Logout"), options)
+    self.class.post(base_api_endpoint("Web/Session/#{session_key}/Logout"), options)
   end
 end

data/lib/tessitura_rest/web/payment_plan_extension.rb

@@ -1,4 +1,5 @@
 module PaymentPlanExtension
+  # to be deprecated
   def add_billing_payment_plan(session_key, billing_id, billing_type_id, name, number, month, year, start_date = nil, end_date = nil, options = {})
     parameters =
       {

data/lib/tessitura_rest/web/registration.rb

@@ -37,4 +37,42 @@ module Registration
     options.merge!(:body => parameters.to_json)
     self.class.post(base_api_endpoint("Web/Registration/#{session_key}/Register"), options)
   end
+
+  def register_user_v16(session_key, address, first_name, last_name, email, password, promotion, special_offer, phone, options = {})
+    parameters =
+      {
+        'FirstName': first_name,
+        'LastName': last_name,
+        'PrimaryElectronicAddress': {
+          'Address': email,
+          'AllowMarketing': special_offer || 0,
+        },
+        'WebLogin': {
+          'Login': email,
+          'LoginTypeId': 1,
+          'Password': password,
+        },
+        'PrimaryAddress': {
+          'AddressTypeId': 3,
+          'City': address.city,
+          'PostalCode': address.postal_code,
+          'StateId': address.state,
+          'Street1': address.street1,
+          'Street2': address.street2,
+          'CountryId': address.country,
+        },
+        'ConstituentTypeId': 1,
+        'OriginalSourceId': 3,
+        'SourceId': promotion,
+        'PrimaryPhone':
+          {
+            'PhoneNumber': phone,
+            'PhoneTypeId': 5,
+          },
+      }
+    options.merge!(basic_auth: @auth, headers: @headers)
+    options.merge!(:body => parameters.to_json)
+    self.class.post(base_api_endpoint("Web/Registration/#{session_key}/Register"), options)
+  end
+
 end

data/lib/tessitura_rest/web/session.rb

@@ -51,6 +51,18 @@ module Session
     JSON.parse(response.body)
   end
 
+  def set_expiration_v16(key, expiration, timeoffset = 0, options = {})
+    parameters =
+      {
+        'Expiration': expiration,
+        'TimeOffset': timeoffset,
+      }
+    options.merge!(basic_auth: @auth, headers: @headers)
+    options.merge!(:body => parameters.to_json)
+    response = self.class.put(base_api_endpoint("Web/Session/#{key}/Expiration"), options)
+    JSON.parse(response.body)
+  end
+
   def load_existing_order(key, order_id, options = {})
     options.merge!(basic_auth: @auth, headers: @headers)
     self.class.post(base_api_endpoint("Web/Session/#{key}/LoadOrder/#{order_id}"), options)
@@ -86,6 +98,19 @@ module Session
     self.class.post(base_api_endpoint("/Web/Session/#{key}/Login/SendCredentials"), options)
   end
 
+  def send_credentials_v16(key, email, login_type, template_id, options = {})
+    parameters =
+      {
+        'TemplateFormatId': template_id,
+        'LoginTypeId': login_type,
+        'EmailAddress': email,
+        'IsPriority': true,
+      }
+    options.merge!(basic_auth: @auth, headers: @headers)
+    options.merge!(:body => parameters.to_json)
+    self.class.post(base_api_endpoint("/Web/Session/#{key}/Login/SendCredentials"), options)
+  end
+
   def update_login(key, user_name, old_password, new_password, email, new_email, options = {})
     parameters =
       {

data/lib/tessitura_rest.rb

@@ -52,6 +52,6 @@ class TessituraRest
   end
 
   def base_api_endpoint(end_point)
-    "#{ENV.fetch('TESSITURA_URL')}#{end_point}"
+    "#{ENV.fetch('TESSITURA_v16_URL')}#{end_point}"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: tessitura_rest
 version: !ruby/object:Gem::Version
-  version: 1.5.1
+  version: 2.0.0
 platform: ruby
 authors:
 - Brittany Martin, Danielle Greaves, Craig Donavin, Patrick FitzGerald
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2024-05-29 00:00:00.000000000 Z
+date: 2024-06-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler