Module: Agris

Defined in:
lib/agris.rb,
lib/agris/api.rb,
lib/agris/client.rb,
lib/agris/context.rb,
lib/agris/version.rb,
lib/agris/api/grain.rb,
lib/agris/api/order.rb,
lib/agris/xml_model.rb,
lib/agris/api/remark.rb,
lib/agris/user_agent.rb,
lib/agris/api/support.rb,
lib/agris/credentials.rb,
lib/agris/api/messages.rb,
lib/agris/api/inventory.rb,
lib/agris/api/new_order.rb,
lib/agris/savon_request.rb,
lib/agris/api/order_line.rb,
lib/agris/api/grain/rates.rb,
lib/agris/api/new_voucher.rb,
lib/agris/api/post_result.rb,
lib/agris/api/grain/tickets.rb,
lib/agris/api/grain/contract.rb,
lib/agris/api/grain/commodity.rb,
lib/agris/api/messages/import.rb,
lib/agris/api/grain/new_ticket.rb,
lib/agris/api/inventory/orders.rb,
lib/agris/api/new_order_remark.rb,
lib/agris/api/accounts_payables.rb,
lib/agris/credentials/anonymous.rb,
lib/agris/api/grain/grain_module.rb,
lib/agris/api/grain/new_contract.rb,
lib/agris/credentials/basic_auth.rb,
lib/agris/api/grain/grade_factors.rb,
lib/agris/api/messages/query_base.rb,
lib/agris/api/accounts_receivables.rb,
lib/agris/process_message_response.rb,
lib/agris/api/grain/commodity_codes.rb,
lib/agris/api/grain/sales_contracts.rb,
lib/agris/api/messages/message_base.rb,
lib/agris/api/document_query_response.rb,
lib/agris/api/grain/new_ticket_remark.rb,
lib/agris/api/grain/purchase_contracts.rb,
lib/agris/api/inventory/delivery_ticket.rb,
lib/agris/api/inventory/delivery_tickets.rb,
lib/agris/api/grain/new_contract_schedule.rb,
lib/agris/api/messages/changed_query_base.rb,
lib/agris/api/accounts_receivables/invoice.rb,
lib/agris/api/grain/new_ticket_application.rb,
lib/agris/api/messages/document_query_base.rb,
lib/agris/api/accounts_receivables/invoices.rb,
lib/agris/api/messages/query_changed_orders.rb,
lib/agris/api/messages/query_order_documents.rb,
lib/agris/api/grain/specific_contract_extract.rb,
lib/agris/api/messages/query_changed_invoices.rb,
lib/agris/api/inventory/specific_order_extract.rb,
lib/agris/api/messages/query_invoice_documents.rb,
lib/agris/api/inventory/delivery_ticket_line_item.rb,
lib/agris/api/grain/specific_commodity_code_extract.rb,
lib/agris/api/messages/query_changed_sales_contracts.rb,
lib/agris/api/messages/query_changed_delivery_tickets.rb,
lib/agris/api/messages/query_commodity_code_documents.rb,
lib/agris/api/messages/query_sales_contract_documents.rb,
lib/agris/api/messages/query_delivery_ticket_documents.rb,
lib/agris/api/messages/query_changed_purchase_contracts.rb,
lib/agris/api/inventory/specific_delivery_ticket_extract.rb,
lib/agris/api/messages/query_purchase_contract_documents.rb,
lib/agris/api/accounts_receivables/specific_invoice_extract.rb

Defined Under Namespace

Modules: Api, Credentials, XmlModel Classes: ApiError, Client, Context, MessageError, ProcessMessageResponse, SavonRequest, SystemError, UnknownError

Constant Summary collapse

VERSION = 
'0.13.0'
USER_AGENT = 
Agris.user_agent.to_s + " (Agris.rb #{VERSION})"

Class Attribute Summary collapse

Class Method Summary collapse

Class Attribute Details

.context ⇒ Object

Returns the value of attribute context.



14
15
16
 
# File 'lib/agris.rb', line 14

def context
  @context
end

.credentials ⇒ Object

Returns the value of attribute credentials.



14
15
16
 
# File 'lib/agris.rb', line 14

def credentials
  @credentials
end

.log_level ⇒ Object

Returns the value of attribute log_level.



14
15
16
 
# File 'lib/agris.rb', line 14

def log_level
  @log_level
end

.logger ⇒ Object

Returns the value of attribute logger.



14
15
16
 
# File 'lib/agris.rb', line 14

def logger
  @logger
end

.proxy_url ⇒ Object

Returns the value of attribute proxy_url.



14
15
16
 
# File 'lib/agris.rb', line 14

def proxy_url
  @proxy_url
end

.request_type ⇒ Object

Returns the value of attribute request_type.



14
15
16
 
# File 'lib/agris.rb', line 14

def request_type
  @request_type
end

.user_agent ⇒ Object

Returns the value of attribute user_agent.



14
15
16
 
# File 'lib/agris.rb', line 14

def user_agent
  @user_agent
end

Class Method Details

.configure {|_self| ... } ⇒ Object

“‘ruby Agris.configure do |config|

config.credentials = Agris::Credentials::Anonymous.new
config.context = Agris::Context.new(
  'http://localhost:3000',
  '001',
  '\\host\apps\Agris\datasets',
  'AgrisDB',
  'bob',
  'fred'
)
config.request_type = Agris::SavonRequest
config.logger = Logger.new(STDOUT)
config.user_agent = 'Otis'

end “‘ elsewhere

“‘ruby client = Agris::Client.new “`

Yields:

  • (_self)

Yield Parameters:

  • _self (Agris) —

    the object that the method was called on



42
43
44
45
 
# File 'lib/agris.rb', line 42

def configure
  yield self
  true
end

.root ⇒ Object 



47
48
49
 
# File 'lib/agris.rb', line 47

def root
  File.expand_path('..', __dir__)
end