/zype-cli

Primary LanguageRuby

Zype-CLI

How to install

  1. Build gem

gem build zype.gemspec

  1. Install gem

gem install ./zype-1.0.0.gem

How to use

  1. Open irb

irb

  1. Require gem

require 'zype'

  1. Configure gem

For a rails application add the following under: config/initializers/zype.rb

Zype.configure do |config| config.api_key = [your api key] config.host = [host] # default: api.zype-core.com config.port = [port] # default: 3000 config.use_ssl = false # default: false end

  1. Create a client

Zype::Client.new

  1. Query zobjects

client.zobjects.all(zobject: 'team')

To Test

  1. Go to spec/spec_helper.rb and edit the Zype configurations where you want your tests to query to.

  2. Run $ rspec spec

  3. API Queries are recorded in spec/support/vcr_cassettes. If you want fresh API queries, delete the Zype directory of yml records and run your tests again!