tessitura_rest 0.7.4

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.4.2
+before_install: gem install bundler -v 1.12.5

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,49 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, and in the interest of
+fostering an open and welcoming community, we pledge to respect all people who
+contribute through reporting issues, posting feature requests, updating
+documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free
+experience for everyone, regardless of level of experience, gender, gender
+identity and expression, sexual orientation, disability, personal appearance,
+body size, race, ethnicity, age, religion, or nationality.
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery
+* Personal attacks
+* Trolling or insulting/derogatory comments
+* Public or private harassment
+* Publishing other's private information, such as physical or electronic
+  addresses, without explicit permission
+* Other unethical or unprofessional conduct
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+By adopting this Code of Conduct, project maintainers commit themselves to
+fairly and consistently applying these principles to every aspect of managing
+this project. Project maintainers who do not follow or enforce the Code of
+Conduct may be permanently removed from the project team.
+
+This code of conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting a project maintainer at brittany.jill.martin@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. Maintainers are
+obligated to maintain confidentiality with regard to the reporter of an
+incident.
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 1.3.0, available at
+[http://contributor-covenant.org/version/1/3/0/][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/3/0/

data/Gemfile

@@ -0,0 +1,10 @@
+source 'https://rubygems.org'
+
+gemspec
+
+group :test do
+  gem 'webmock'
+  gem 'vcr'
+  gem 'simplecov'
+  gem 'dotenv'
+end

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 The Pittsburgh Cultural Trust
+
+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,89 @@
+# TessituraRest
+
+A Ruby gem wrapper for the [TessituraRest Network's Rest API](https://www.tessituranetwork.com/) (version 14 and up).
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+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    
+
+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.     
+
+## 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.
+3. Create a .env file and set these values:
+
+* TESSITURA_URL          # the url to your Test/Staging 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
+* WEB_CART_TEXT          # the ID to the pricing rule you have setup for Cart
+* ORDER_CONFIRM_TEXT     # the ID to the pricing rule you have setup for Order Confirmations
+* 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.
+
+## 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.
+
+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.
+
+## 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,14 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec
+
+task :console do
+  require 'irb'
+  require 'irb/completion'
+  require 'tessitura_rest'
+  ARGV.clear
+  IRB.start
+end

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "tessitura"
+
+# 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,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/tessitura_rest.rb

@@ -0,0 +1,52 @@
+require 'require_all'
+require_rel 'tessitura_rest'
+require 'json'
+require 'httparty'
+
+class TessituraRest
+  include HTTParty
+
+  include Accounts
+  include Actions
+  include Addresses
+  include Attributes
+  include Appeals
+  include BillingSchedules
+  include Cart
+  include Constituencies
+  include Countries
+  include Diagnostics
+  include Email
+  include GiftCertificates
+  include Issues
+  include LocalProcedure
+  include Login
+  include Orders
+  include Package
+  include PaymentPlanExtension
+  include PerformanceExtension
+  include PerformancePackageModeOfSales
+  include Phones
+  include PriceTypes
+  include ProductionExtension
+  include ProductKeywords
+  include ProductionSeason
+  include Sections
+  include Session
+  include SecurityUserGroups
+  include States
+  include SubLineItems
+  include WebContents
+  include WebLogins
+
+  def initialize(options={})
+    @auth = { username: ENV['TESSITURA_USERNAME'],
+              password: ENV['TESSITURA_PASSWORD'] }
+    @headers = { 'Accept': 'application/json' }
+  end
+
+  def base_api_endpoint(end_point)
+    "#{ENV['TESSITURA_URL']}#{end_point}"
+  end
+
+end

data/lib/tessitura_rest/crm/accounts.rb

@@ -0,0 +1,8 @@
+module Accounts
+
+  def get_all_accounts(constituent_id, inactive=false, include_affiliate=false, options={})
+    options.merge!(basic_auth: @auth, headers: @headers)
+    response = self.class.get(base_api_endpoint("CRM/Accounts?constituentId=#{constituent_id}&includeInactive=#{inactive}&includeAffiliates=#{include_affiliate}"), options)
+    JSON.parse(response.body)
+  end
+end

data/lib/tessitura_rest/crm/actions.rb

@@ -0,0 +1,36 @@
+module Actions
+
+  def get_action(id, options={})
+    options.merge!(basic_auth: @auth, headers: @headers)
+    response = self.class.get(base_api_endpoint("CRM/Actions/#{id}"), options)
+    JSON.parse(response.body)
+  end
+
+  def get_actions(constituent_id, issue_id, options={})
+    options.merge!(basic_auth: @auth, headers: @headers)
+    response = self.class.get(base_api_endpoint("CRM/Actions?constituentId=#{constituent_id}&issueId=#{issue_id}"), options)
+    JSON.parse(response.body)
+  end
+
+  def create_action(action_type, constituent_id, issue_id, notes = '', options={})
+    parameters =
+    {
+      'ActionType': {
+        'Id': action_type
+      },
+      'Issue': {
+        'Id': issue_id
+      },
+      'Constituent': {
+        'Id': constituent_id
+      },
+      'Notes': notes,
+      'Resolved': true,
+    }
+    options.merge!(basic_auth: @auth, headers: @headers)
+    options.merge!(:body => parameters)
+    response = self.class.post(base_api_endpoint('CRM/Actions'), options)
+    JSON.parse(response.body)
+  end
+
+end

data/lib/tessitura_rest/crm/addresses.rb

@@ -0,0 +1,122 @@
+module Addresses
+
+  def get_address(address_id, options={})
+    options.merge!(basic_auth: @auth, headers: @headers)
+    response = self.class.get(base_api_endpoint("CRM/Addresses/#{address_id}"), options)
+    JSON.parse(response.body)
+  end
+
+  def get_all_addresses(constituent_id, options={})
+    options.merge!(basic_auth: @auth, headers: @headers)
+    response = self.class.get(base_api_endpoint("CRM/Addresses?constituentId=#{constituent_id}"), options)
+    JSON.parse(response.body)
+  end
+
+  def create_address(constituent, address_type, city, postal_code, state, country, street1, street2, primary, options={})
+    parameters =
+    {
+      'AddressType': {
+        'Id': address_type
+      },
+      'City': city,
+      'Constituent': {
+        'Id': constituent
+      },
+      'Inactive': false,
+      'Label': true,
+      'Months': 'YYYYYYYYYYYY',
+      'PostalCode': postal_code,
+      'PrimaryIndicator': primary,
+      'State': {
+        'Id': state,
+        'Country': {
+          'Id': country
+        }
+      },
+      'Street1': street1,
+      'Street2': street2,
+      'Country': {
+        'Id': country
+      }
+    }
+    options.merge!(basic_auth: @auth, headers: @headers)
+    options.merge!(:body => parameters)
+    response = self.class.post(base_api_endpoint("CRM/Addresses"), options)
+    JSON.parse(response.body)
+  end
+
+  def update_address(id, address_type, city, postal_code, state, country, street1, street2, primary, options={})
+    current = get_address(id)
+    parameters =
+    {
+      'Id': id,
+      'UpdatedDateTime': current['UpdatedDateTime'],
+      'AddressType': {
+        'Id': address_type
+      },
+      'City': city,
+      'Constituent': {
+        'Id': current['Constituent']['Id']
+      },
+      'Inactive': false,
+      'Label': true,
+      'Months': 'YYYYYYYYYYYY',
+      'PostalCode': postal_code,
+      'PrimaryIndicator': primary,
+      'State': {
+        'Id': state,
+        'Country': {
+          'Id': country
+        }
+      },
+      'Street1': street1,
+      'Street2': street2,
+      'Country': {
+        'Id': country
+      }
+    }
+    options.merge!(basic_auth: @auth, headers: @headers)
+    options.merge!(:body => parameters)
+    response = self.class.put(base_api_endpoint("CRM/Addresses/#{id}"), options)
+    JSON.parse(response.body)
+  end
+
+  def deactivate_address(id, options={})
+    current = get_address(id)
+    parameters =
+    {
+      'Id': id,
+      'UpdatedDateTime': current['UpdatedDateTime'],
+      'AddressType': {
+        'Id': current['AddressType']['Id']
+      },
+      'City': current['City'],
+      'Constituent': {
+        'Id': current['Constituent']['Id']
+      },
+      'Inactive': true,
+      'Label': true,
+      'Months': 'YYYYYYYYYYYY',
+      'PostalCode': current['PostalCode'],
+      'State': {
+        'Id': current['State']['Id'],
+        'Country': {
+          'Id': current['Country']['Id']
+        }
+      },
+      'Street1': current['Street1'],
+      'Street2': current['Street2'],
+      'Country': {
+        'Id': current['Country']['Id']
+      }
+    }
+    options.merge!(basic_auth: @auth, headers: @headers)
+    options.merge!(:body => parameters)
+    self.class.put(base_api_endpoint("CRM/Addresses/#{id}"), options)
+  end
+
+  def delete_address(address_id, options={})
+    options.merge!(basic_auth: @auth, headers: @headers)
+    self.class.delete(base_api_endpoint("CRM/Addresses/#{address_id}"), options)
+  end
+end

data/lib/tessitura_rest/crm/attributes.rb

@@ -0,0 +1,20 @@
+module Attributes
+
+  def add_attribute(constituent_id, attribute_id, value, options={})
+    parameters =
+      {
+          'Keyword' => {
+              'Id'=> attribute_id
+          },
+          'Constituent'=> {
+              'Id'=> constituent_id
+          },
+          'Value'=> value,
+          'UpdatedDateTime'=> DateTime.now.to_s
+      }
+    options.merge!(basic_auth: @auth, headers: @headers)
+    options.merge!(:body => parameters)
+    response = self.class.post(base_api_endpoint('CRM/Attributes'), options)
+    JSON.parse(response.body)
+  end
+end