From ba06f7f8a47bde8ae5f9aeb52d7765bcbb8ce974 Mon Sep 17 00:00:00 2001 From: Julian Cheal Date: Thu, 25 Aug 2016 15:08:21 +0100 Subject: [PATCH] Added basic structure for a ruby gem --- .gitignore | 51 ++++------------------------------ .rspec | 2 ++ .travis.yml | 5 ++++ CODE_OF_CONDUCT.md | 49 ++++++++++++++++++++++++++++++++ Gemfile | 4 +++ README.md | 37 ++++++++++++++++++++++-- Rakefile | 6 ++++ bin/console | 14 ++++++++++ bin/setup | 8 ++++++ lib/xclarity_client.rb | 5 ++++ lib/xclarity_client/version.rb | 3 ++ spec/spec_helper.rb | 2 ++ spec/xclarity_client_spec.rb | 11 ++++++++ xclarity_client.gemspec | 32 +++++++++++++++++++++ 14 files changed, 181 insertions(+), 48 deletions(-) create mode 100644 .rspec create mode 100644 .travis.yml create mode 100644 CODE_OF_CONDUCT.md create mode 100644 Gemfile create mode 100644 Rakefile create mode 100755 bin/console create mode 100755 bin/setup create mode 100644 lib/xclarity_client.rb create mode 100644 lib/xclarity_client/version.rb create mode 100644 spec/spec_helper.rb create mode 100644 spec/xclarity_client_spec.rb create mode 100644 xclarity_client.gemspec diff --git a/.gitignore b/.gitignore index 5e1422c9c3..0cb6eeb067 100644 --- a/.gitignore +++ b/.gitignore @@ -1,50 +1,9 @@ -*.gem -*.rbc -/.config +/.bundle/ +/.yardoc +/Gemfile.lock +/_yardoc/ /coverage/ -/InstalledFiles +/doc/ /pkg/ /spec/reports/ -/spec/examples.txt -/test/tmp/ -/test/version_tmp/ /tmp/ - -# Used by dotenv library to load environment variables. -# .env - -## Specific to RubyMotion: -.dat* -.repl_history -build/ -*.bridgesupport -build-iPhoneOS/ -build-iPhoneSimulator/ - -## Specific to RubyMotion (use of CocoaPods): -# -# We recommend against adding the Pods directory to your .gitignore. However -# you should judge for yourself, the pros and cons are mentioned at: -# https://guides.cocoapods.org/using/using-cocoapods.html#should-i-check-the-pods-directory-into-source-control -# -# vendor/Pods/ - -## Documentation cache and generated files: -/.yardoc/ -/_yardoc/ -/doc/ -/rdoc/ - -## Environment normalization: -/.bundle/ -/vendor/bundle -/lib/bundler/man/ - -# for a library or gem, you might want to ignore these files since the code is -# intended to run in multiple environments; otherwise, check them in: -# Gemfile.lock -# .ruby-version -# .ruby-gemset - -# unless supporting rvm < 1.11.0 or doing something fancy, ignore this: -.rvmrc diff --git a/.rspec b/.rspec new file mode 100644 index 0000000000..8c18f1abdd --- /dev/null +++ b/.rspec @@ -0,0 +1,2 @@ +--format documentation +--color diff --git a/.travis.yml b/.travis.yml new file mode 100644 index 0000000000..4060626d83 --- /dev/null +++ b/.travis.yml @@ -0,0 +1,5 @@ +sudo: false +language: ruby +rvm: + - 2.2.4 +before_install: gem install bundler -v 1.12.5 diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md new file mode 100644 index 0000000000..df655ccda8 --- /dev/null +++ b/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 jcheal@redhat.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/ \ No newline at end of file diff --git a/Gemfile b/Gemfile new file mode 100644 index 0000000000..794cc59f96 --- /dev/null +++ b/Gemfile @@ -0,0 +1,4 @@ +source 'https://rubygems.org' + +# Specify your gem's dependencies in xclarity_client.gemspec +gemspec diff --git a/README.md b/README.md index 7cbdc35108..69008724e1 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,35 @@ -# xclarityclient -A Ruby client for XClarity REST API +# XClarity Client + +Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/xclarity_client`. To experiment with that code, run `bin/console` for an interactive prompt. + +TODO: Delete this and the text above, and describe your gem + +## Installation + +Add this line to your application's Gemfile: + +```ruby +gem 'xclarity_client' +``` + +And then execute: + + $ bundle + +Or install it yourself as: + + $ gem install xclarity_client + +## Usage + +TODO: Write usage instructions here + +## 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/[USERNAME]/xclarity_client. 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. diff --git a/Rakefile b/Rakefile new file mode 100644 index 0000000000..b7e9ed549b --- /dev/null +++ b/Rakefile @@ -0,0 +1,6 @@ +require "bundler/gem_tasks" +require "rspec/core/rake_task" + +RSpec::Core::RakeTask.new(:spec) + +task :default => :spec diff --git a/bin/console b/bin/console new file mode 100755 index 0000000000..58647d527f --- /dev/null +++ b/bin/console @@ -0,0 +1,14 @@ +#!/usr/bin/env ruby + +require "bundler/setup" +require "xclarity_client" + +# 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 diff --git a/bin/setup b/bin/setup new file mode 100755 index 0000000000..dce67d860a --- /dev/null +++ b/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 diff --git a/lib/xclarity_client.rb b/lib/xclarity_client.rb new file mode 100644 index 0000000000..98c0ee824f --- /dev/null +++ b/lib/xclarity_client.rb @@ -0,0 +1,5 @@ +require "xclarity_client/version" + +module XclarityClient + # Your code goes here... +end diff --git a/lib/xclarity_client/version.rb b/lib/xclarity_client/version.rb new file mode 100644 index 0000000000..a6de5970a0 --- /dev/null +++ b/lib/xclarity_client/version.rb @@ -0,0 +1,3 @@ +module XclarityClient + VERSION = "0.1.0" +end diff --git a/spec/spec_helper.rb b/spec/spec_helper.rb new file mode 100644 index 0000000000..de88252714 --- /dev/null +++ b/spec/spec_helper.rb @@ -0,0 +1,2 @@ +$LOAD_PATH.unshift File.expand_path('../../lib', __FILE__) +require 'xclarity_client' diff --git a/spec/xclarity_client_spec.rb b/spec/xclarity_client_spec.rb new file mode 100644 index 0000000000..3340f3f6f6 --- /dev/null +++ b/spec/xclarity_client_spec.rb @@ -0,0 +1,11 @@ +require 'spec_helper' + +describe XclarityClient do + it 'has a version number' do + expect(XclarityClient::VERSION).not_to be nil + end + + it 'does something useful' do + expect(false).to eq(true) + end +end diff --git a/xclarity_client.gemspec b/xclarity_client.gemspec new file mode 100644 index 0000000000..0c6f21bccc --- /dev/null +++ b/xclarity_client.gemspec @@ -0,0 +1,32 @@ +# coding: utf-8 +lib = File.expand_path('../lib', __FILE__) +$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib) +require 'xclarity_client/version' + +Gem::Specification.new do |spec| + spec.name = "xclarity_client" + spec.version = XclarityClient::VERSION + spec.authors = ["Julian Cheal"] + spec.email = ["jcheal@redhat.com"] + + spec.summary = %q{TODO: Write a short summary, because Rubygems requires one.} + spec.description = %q{TODO: Write a longer description or delete this line.} + spec.homepage = "TODO: Put your gem's website or public repo URL here." + + # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host' + # to allow pushing to a single host or delete this section to allow pushing to any host. + if spec.respond_to?(:metadata) + spec.metadata['allowed_push_host'] = "TODO: Set to 'http://mygemserver.com'" + else + raise "RubyGems 2.0 or newer is required to protect against public gem pushes." + end + + spec.files = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) } + spec.bindir = "exe" + spec.executables = spec.files.grep(%r{^exe/}) { |f| File.basename(f) } + spec.require_paths = ["lib"] + + spec.add_development_dependency "bundler", "~> 1.12" + spec.add_development_dependency "rake", "~> 10.0" + spec.add_development_dependency "rspec", "~> 3.0" +end