Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix: rdoc generation excluding MODEL_CLASS (closes #317) #318

Merged
merged 2 commits into from
Dec 17, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion easypost.gemspec
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ Gem::Specification.new do |spec|
spec.add_development_dependency 'faraday', '~> 2.7.5' # used for integration tests
spec.add_development_dependency 'pry', '~> 0.14'
spec.add_development_dependency 'rake', '~> 13.0'
spec.add_development_dependency 'rdoc', '~> 6.5'
spec.add_development_dependency 'rdoc', '~> 6.9'
spec.add_development_dependency 'rspec', '~> 3.12'
spec.add_development_dependency 'rubocop', '~> 1.49'
spec.add_development_dependency 'rubocop-rspec', '2.19' # pin to 2.19 because latest version doesn't support Ruby 2.6
Expand Down
2 changes: 1 addition & 1 deletion lib/easypost/services/address.rb
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# frozen_string_literal: true

class EasyPost::Services::Address < EasyPost::Services::Service
MODEL_CLASS = EasyPost::Models::Address
MODEL_CLASS = EasyPost::Models::Address # :nodoc:

# Create an address.
def create(params = {})
Expand Down
2 changes: 1 addition & 1 deletion lib/easypost/services/batch.rb
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# frozen_string_literal: true

class EasyPost::Services::Batch < EasyPost::Services::Service
MODEL_CLASS = EasyPost::Models::Batch
MODEL_CLASS = EasyPost::Models::Batch # :nodoc:

# Create a Batch.
def create(params = {})
Expand Down
2 changes: 1 addition & 1 deletion lib/easypost/services/carrier_account.rb
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
class EasyPost::Services::CarrierAccount < EasyPost::Services::Service
CUSTOM_WORKFLOW_CARRIER_TYPES = %w[FedexAccount FedexSmartpostAccount].freeze
UPS_OAUTH_CARRIER_ACCOUNT_TYPES = %w[UpsAccount UpsMailInnovationsAccount UpsSurepostAccount].freeze
MODEL_CLASS = EasyPost::Models::CarrierAccount
MODEL_CLASS = EasyPost::Models::CarrierAccount # :nodoc:

# Create a carrier account
def create(params = {})
Expand Down
2 changes: 1 addition & 1 deletion lib/easypost/services/carrier_type.rb
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# frozen_string_literal: true

class EasyPost::Services::CarrierType < EasyPost::Services::Service
MODEL_CLASS = EasyPost::Models::CarrierType
MODEL_CLASS = EasyPost::Models::CarrierType # :nodoc:

# Retrieve all carrier types
def all
Expand Down
2 changes: 1 addition & 1 deletion lib/easypost/services/claim.rb
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# frozen_string_literal: true

class EasyPost::Services::Claim < EasyPost::Services::Service
MODEL_CLASS = EasyPost::Models::Claim
MODEL_CLASS = EasyPost::Models::Claim # :nodoc:

# Create an Claim object
def create(params = {})
Expand Down
2 changes: 1 addition & 1 deletion lib/easypost/services/customs_info.rb
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# frozen_string_literal: true

class EasyPost::Services::CustomsInfo < EasyPost::Services::Service
MODEL_CLASS = EasyPost::Models::CustomsInfo
MODEL_CLASS = EasyPost::Models::CustomsInfo # :nodoc:

# Create a CustomsInfo object
def create(params)
Expand Down
2 changes: 1 addition & 1 deletion lib/easypost/services/customs_item.rb
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# frozen_string_literal: true

class EasyPost::Services::CustomsItem < EasyPost::Services::Service
MODEL_CLASS = EasyPost::Models::CustomsItem
MODEL_CLASS = EasyPost::Models::CustomsItem # :nodoc:

# Create a CustomsItem object
def create(params)
Expand Down
2 changes: 1 addition & 1 deletion lib/easypost/services/end_shipper.rb
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# frozen_string_literal: true

class EasyPost::Services::EndShipper < EasyPost::Services::Service
MODEL_CLASS = EasyPost::Models::EndShipper
MODEL_CLASS = EasyPost::Models::EndShipper # :nodoc:

# Create an EndShipper object.
def create(params = {})
Expand Down
2 changes: 1 addition & 1 deletion lib/easypost/services/event.rb
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
require 'json'

class EasyPost::Services::Event < EasyPost::Services::Service
MODEL_CLASS = EasyPost::Models::Event
MODEL_CLASS = EasyPost::Models::Event # :nodoc:

# Retrieve an Event object
def retrieve(id)
Expand Down
2 changes: 1 addition & 1 deletion lib/easypost/services/insurance.rb
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# frozen_string_literal: true

class EasyPost::Services::Insurance < EasyPost::Services::Service
MODEL_CLASS = EasyPost::Models::Insurance
MODEL_CLASS = EasyPost::Models::Insurance # :nodoc:

# Create an Insurance object
def create(params = {})
Expand Down
2 changes: 1 addition & 1 deletion lib/easypost/services/order.rb
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# frozen_string_literal: true

class EasyPost::Services::Order < EasyPost::Services::Service
MODEL_CLASS = EasyPost::Models::Order
MODEL_CLASS = EasyPost::Models::Order # :nodoc:

# Create an Order object
def create(params = {})
Expand Down
2 changes: 1 addition & 1 deletion lib/easypost/services/parcel.rb
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# frozen_string_literal: true

class EasyPost::Services::Parcel < EasyPost::Services::Service
MODEL_CLASS = EasyPost::Models::Parcel
MODEL_CLASS = EasyPost::Models::Parcel # :nodoc:

# Create a Parcel object
def create(params = {})
Expand Down
2 changes: 1 addition & 1 deletion lib/easypost/services/pickup.rb
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# frozen_string_literal: true

class EasyPost::Services::Pickup < EasyPost::Services::Service
MODEL_CLASS = EasyPost::Models::Pickup
MODEL_CLASS = EasyPost::Models::Pickup # :nodoc:

# Create a Pickup object
def create(params = {})
Expand Down
2 changes: 1 addition & 1 deletion lib/easypost/services/referral_customer.rb
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# frozen_string_literal: true

class EasyPost::Services::ReferralCustomer < EasyPost::Services::Service
MODEL_CLASS = EasyPost::Models::User
MODEL_CLASS = EasyPost::Models::User # :nodoc:

# Create a referral customer. This function requires the Partner User's API key.
def create(params = {})
Expand Down
2 changes: 1 addition & 1 deletion lib/easypost/services/refund.rb
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# frozen_string_literal: true

class EasyPost::Services::Refund < EasyPost::Services::Service
MODEL_CLASS = EasyPost::Models::Refund
MODEL_CLASS = EasyPost::Models::Refund # :nodoc:

# Create a Refund object
def create(params = {})
Expand Down
2 changes: 1 addition & 1 deletion lib/easypost/services/report.rb
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# frozen_string_literal: true

class EasyPost::Services::Report < EasyPost::Services::Service
MODEL_CLASS = EasyPost::Models::Report
MODEL_CLASS = EasyPost::Models::Report # :nodoc:

# Create a Report
def create(params = {})
Expand Down
2 changes: 1 addition & 1 deletion lib/easypost/services/scan_form.rb
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# frozen_string_literal: true

class EasyPost::Services::ScanForm < EasyPost::Services::Service
MODEL_CLASS = EasyPost::Models::ScanForm
MODEL_CLASS = EasyPost::Models::ScanForm # :nodoc:

# Create a ScanForm.
def create(params = {})
Expand Down
2 changes: 1 addition & 1 deletion lib/easypost/services/shipment.rb
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
require 'set'

class EasyPost::Services::Shipment < EasyPost::Services::Service
MODEL_CLASS = EasyPost::Models::Shipment
MODEL_CLASS = EasyPost::Models::Shipment # :nodoc:

# Create a Shipment.
def create(params = {})
Expand Down
2 changes: 1 addition & 1 deletion lib/easypost/services/tracker.rb
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# frozen_string_literal: true

class EasyPost::Services::Tracker < EasyPost::Services::Service
MODEL_CLASS = EasyPost::Models::Tracker
MODEL_CLASS = EasyPost::Models::Tracker # :nodoc:

# Create a Tracker
def create(params = {})
Expand Down
2 changes: 1 addition & 1 deletion lib/easypost/services/user.rb
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# frozen_string_literal: true

class EasyPost::Services::User < EasyPost::Services::Service
MODEL_CLASS = EasyPost::Models::User
MODEL_CLASS = EasyPost::Models::User # :nodoc:

# Create a child User.
def create(params = {})
Expand Down
2 changes: 1 addition & 1 deletion lib/easypost/services/webhook.rb
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# frozen_string_literal: true

class EasyPost::Services::Webhook < EasyPost::Services::Service
MODEL_CLASS = EasyPost::Models::Webhook
MODEL_CLASS = EasyPost::Models::Webhook # :nodoc:

# Create a Webhook.
def create(params = {})
Expand Down
Loading