Skip to content

Commit

Permalink
Create basic gem and configuration object
Browse files Browse the repository at this point in the history
  • Loading branch information
Nick Maher committed Apr 9, 2016
0 parents commit ddefef6
Show file tree
Hide file tree
Showing 17 changed files with 233 additions and 0 deletions.
9 changes: 9 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
/.bundle/
/.yardoc
/Gemfile.lock
/_yardoc/
/coverage/
/doc/
/pkg/
/spec/reports/
/tmp/
2 changes: 2 additions & 0 deletions .rspec
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
--format documentation
--color
1 change: 1 addition & 0 deletions .ruby-version
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
2.3.0
4 changes: 4 additions & 0 deletions .travis.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
language: ruby
rvm:
- 2.3.0
before_install: gem install bundler -v 1.11.2
3 changes: 3 additions & 0 deletions Gemfile
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
source 'https://rubygems.org'

gemspec
21 changes: 21 additions & 0 deletions LICENSE.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
The MIT License (MIT)

Copyright (c) 2016 Nick Maher

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.
39 changes: 39 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
# CiscoSpark
Ruby SDK for [MIT License](https://developer.ciscospark.com).

Work in progress currently

## Installation

Add this line to your application's Gemfile:

```ruby
gem 'cisco_spark'
```

And then execute:

$ bundle

Or install it yourself as:

$ gem install cisco_spark

## Usage

WIP

## 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/NGMarmaduke/cisco_spark.

## License

The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

6 changes: 6 additions & 0 deletions Rakefile
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
require "bundler/gem_tasks"
require "rspec/core/rake_task"

RSpec::Core::RakeTask.new(:spec)

task :default => :spec
7 changes: 7 additions & 0 deletions bin/console
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
#!/usr/bin/env ruby

require "bundler/setup"
require "cisco_spark"

require "pry"
Pry.start
8 changes: 8 additions & 0 deletions bin/setup
Original file line number Diff line number Diff line change
@@ -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
26 changes: 26 additions & 0 deletions cisco_spark.gemspec
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
# coding: utf-8
lib = File.expand_path('../lib', __FILE__)
$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
require 'cisco_spark/version'

Gem::Specification.new do |spec|
spec.name = "cisco_spark"
spec.version = CiscoSpark::VERSION
spec.authors = ["Nick Maher"]
spec.email = ["[email protected]"]

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."
spec.license = "MIT"

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.11"
spec.add_development_dependency "rake", "~> 10.0"
spec.add_development_dependency "rspec", "~> 3.0"
spec.add_development_dependency "pry"
end
20 changes: 20 additions & 0 deletions lib/cisco_spark.rb
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
require "cisco_spark/configuration"
require "cisco_spark/errors"
require "cisco_spark/version"

module CiscoSpark
extend SingleForwardable
def_delegators :configuration, *Configuration.params

def self.configuration
@configuration ||= Configuration.new
end

def self.configure
yield(configuration)
end

def self.clear_configuration!
@configuration = Configuration.new
end
end
18 changes: 18 additions & 0 deletions lib/cisco_spark/configuration.rb
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
module CiscoSpark
class Configuration
def self.params
[:api_key, :api_version, :api_domain]
end
attr_accessor *self.params

def initialize
@api_version = 'v1'
@api_domain = 'api.ciscospark.com'
end

def api_key
raise NoApiKeyError unless @api_key
@api_key
end
end
end
3 changes: 3 additions & 0 deletions lib/cisco_spark/errors.rb
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
module CiscoSpark
class NoApiKeyError < StandardError; end
end
3 changes: 3 additions & 0 deletions lib/cisco_spark/version.rb
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
module CiscoSpark
VERSION = "0.1.0"
end
61 changes: 61 additions & 0 deletions spec/cisco_spark_spec.rb
Original file line number Diff line number Diff line change
@@ -0,0 +1,61 @@
require 'spec_helper'

describe CiscoSpark do
it 'has a version number' do
expect(CiscoSpark::VERSION).not_to be nil
end

context '#configuration' do
after(:each) do
CiscoSpark.clear_configuration!
end

context 'api_key' do
let(:api_key) { SecureRandom.hex }

it 'stores api an api key' do
CiscoSpark.configure do |config|
config.api_key = api_key
end

expect(CiscoSpark.api_key).to eq(api_key)
end

it 'raises an expection when the key is not set' do
expect{CiscoSpark.api_key}.to raise_error(CiscoSpark::NoApiKeyError)
end
end

context 'api_version' do
let(:api_version) { 'any_version' }

it 'stores api version' do
CiscoSpark.configure do |config|
config.api_version = api_version
end

expect(CiscoSpark.api_version).to eq(api_version)
end

it 'stores defaults to v1' do
expect(CiscoSpark.api_version).to eq('v1')
end
end

context 'api_domain' do
let(:api_domain) { 'api.example.com' }

it 'stores the domain' do
CiscoSpark.configure do |config|
config.api_domain = api_domain
end

expect(CiscoSpark.api_domain).to eq(api_domain)
end

it 'stores defaults to api.ciscospark.com' do
expect(CiscoSpark.api_domain).to eq('api.ciscospark.com')
end
end
end
end
2 changes: 2 additions & 0 deletions spec/spec_helper.rb
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
$LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
require 'cisco_spark'

0 comments on commit ddefef6

Please sign in to comment.