bidsketch 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: db1598ce2696eb6d78a8419e6aabbf9923064457
+  data.tar.gz: b88a0b4bb73a8751981d118ed9fbe2ea310ba38d
+SHA512:
+  metadata.gz: 9de03a07de023662048df8ccee3ad58b1909a3b7034a7fa0f016212c771be542a31e49387be2d6d47c265f25184e4103dedd6e200761ae5d20e87aaa11e32cb6
+  data.tar.gz: 5709cabd1d2efb2da1c7d642a366f0f11be6d7260a3d53c6579c589dc05a621e76d31a66cd0caeae807803e05582a3cd8097aaf2e3d93dcda40d31f0b62d126f

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/Gemfile

@@ -0,0 +1,11 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in bidsketch.gemspec
+gemspec
+
+group :test do
+  gem 'rspec'
+  gem 'webmock'
+  gem 'vcr'
+  gem 'dotenv'
+end

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 Dylan Montgomery
+
+MIT License
+
+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.

data/README.md

@@ -0,0 +1,110 @@
+# Bidsketch
+
+The bidsketch gem is a ruby wrapper for interacting with the [Bidsketch API](https://github.com/Bidsketch/bidsketch-api). 
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'bidsketch'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install bidsketch
+
+## Getting Started
+
+You will need a Bidsketch API key. For instructions on finding your API key: http://help.bidsketch.com/article/76-using-the-bidsketch-api
+
+## Authentication
+
+```ruby
+Bidsketch.api_key = 'YOUR API KEY'
+```
+Alternatively you can set your API key as an environment variable:
+
+```ruby
+ENV['BIDSKETCH_API_KEY'] = 'YOUR API KEY'
+```
+## Clients
+To get all clients:
+
+```ruby
+Bidsketch::Client.all
+```
+
+To get a particular client:
+
+```ruby
+Bidsketch::Client.find(id)
+```
+
+## Fees
+
+To get all fees:
+
+```ruby
+Bidsketch::Fee.all
+```
+
+To get a particular fee:
+
+```ruby
+Bidsketch::Fee.find(id)
+```
+
+## Proposals
+
+To get all proposals:
+
+```ruby
+Bidsketch::Proposal.all
+```
+
+To get a particular proposal:
+
+```ruby
+Bidsketch::Proposal.find(id)
+```
+
+## Sections
+
+To get all sections
+
+```ruby
+Bidsketch::Section.all
+```
+
+To get a particular section:
+
+```ruby
+Bidsketch::Section.find(id)
+```
+
+## Templates
+
+To get all templates:
+
+```ruby
+Bidsketch::Template.all
+```
+
+To get a particular template:
+
+```ruby
+Bidsketch::Template.find(id)
+```
+
+## Contributing
+
+1. Fork it ( https://github.com/citizens/bidsketch-ruby/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+

data/bidsketch.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'bidsketch/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "bidsketch"
+  spec.version       = Bidsketch::VERSION
+  spec.authors       = ["Dylan Montgomery"]
+  spec.email         = ["mail@citizensinspace.com"]
+  spec.summary       = %q{Ruby wrapper for the Bidsketch API}
+  spec.homepage      = "https://github.com/citizens/bidsketch-ruby"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.7"
+  spec.add_development_dependency "rake", "~> 10.0"
+
+  spec.add_dependency 'rest-client'
+  spec.add_dependency 'json'
+  spec.add_dependency 'queryparams'
+end

data/lib/bidsketch/api.rb

@@ -0,0 +1,40 @@
+require 'rest_client'
+require 'json'
+
+module Bidsketch
+  class API
+    BASE_URL = 'https://bidsketch.com/api/v1'
+
+    class << self
+      def get(path, options = {})
+        url = api_url(path)
+        if options[:params]
+          url += "&#{querify(options[:params])}"
+        end
+
+        headers = { authorization: "Token token=#{ENV['BIDSKETCH_API_KEY']}" }
+        normalize_response RestClient.get(url, headers)
+      end
+
+      
+      private
+
+      def normalize_response(response)
+        JSON.parse(response)
+      end
+
+      def api_url(path)
+        "#{BASE_URL}#{tokenize(path)}"
+      end
+
+      def querify(hash)
+        hash.map { |k, v| "#{k}=#{v}".to_s }.join('&')
+      end
+
+      def tokenize(path)
+        param_separator = path.include?('?') ? '&' : '?'
+        path += "#{param_separator}token=#{Bidsketch.api_key}"
+      end
+    end
+  end
+end

data/lib/bidsketch/bidsketch_object.rb

@@ -0,0 +1,21 @@
+require 'ostruct'
+
+module Bidsketch
+  class BidsketchObject < OpenStruct
+    class << self
+      def all
+        Bidsketch::API.get("#{root_path}.json").map { |object| self.new(object) }
+      end
+
+      def find(id)
+        response = Bidsketch::API.get("#{root_path}/#{id}.json")
+        self.new(response)
+      end
+
+      def root_path
+        class_name = self.to_s.gsub(/^.*::/, '').downcase
+        "/#{class_name}s"
+      end
+    end
+  end
+end

data/lib/bidsketch/client.rb

@@ -0,0 +1,4 @@
+module Bidsketch
+  class Client < BidsketchObject
+  end
+end

data/lib/bidsketch/fee.rb

@@ -0,0 +1,4 @@
+module Bidsketch
+  class Fee < BidsketchObject
+  end
+end

data/lib/bidsketch/proposal.rb

@@ -0,0 +1,4 @@
+module Bidsketch
+  class Proposal < BidsketchObject
+  end
+end

data/lib/bidsketch/section.rb

@@ -0,0 +1,4 @@
+module Bidsketch
+  class Section < BidsketchObject
+  end
+end

data/lib/bidsketch/template.rb

@@ -0,0 +1,4 @@
+module Bidsketch
+  class Template < BidsketchObject
+  end
+end

data/lib/bidsketch/version.rb

@@ -0,0 +1,3 @@
+module Bidsketch
+  VERSION = "0.0.1"
+end

data/lib/bidsketch.rb

@@ -0,0 +1,20 @@
+require "bidsketch/version"
+require "bidsketch/api"
+require "bidsketch/bidsketch_object"
+require "bidsketch/client"
+require "bidsketch/fee"
+require "bidsketch/proposal"
+require "bidsketch/section"
+require "bidsketch/template"
+
+module Bidsketch
+  class << self
+    def api_key
+      @api_key || ENV['BIDSKETCH_API_KEY']
+    end
+
+    def api_key=(key)
+      @api_key = key
+    end
+  end
+end

data/spec/client_spec.rb

@@ -0,0 +1,13 @@
+describe Bidsketch::Client, vcr: true do
+  it_should_behave_like 'a listable object', Bidsketch::Client, [
+    :id, :first_name, :last_name, :email, :name, :phone,
+    :url, :app_url, :created_at, :updated_at
+  ]   
+
+  it_should_behave_like 'a findable object',  356834, [
+    :id, :first_name, :last_name, :email, :name, :phone, :alt_phone,
+    :website, :address_field_one, :address_field_two, :city, :state,
+    :postal_zip, :country, :notes, :other_contact, :url, :app_url, 
+    :created_at, :updated_at
+  ]
+end

data/spec/fee_spec.rb

@@ -0,0 +1,13 @@
+describe Bidsketch::Fee, vcr: true do
+  it_should_behave_like 'a listable object', Bidsketch::Fee, [
+    :id, :name, :url, :app_url, :created_at, :updated_at,
+    :category, :total, :feetype, :details
+  ]   
+
+
+  it_should_behave_like 'a findable object',  180219, [
+    :id, :name, :url, :app_url, :created_at, :updated_at,
+    :quantity, :category, :total, :currency, :amount, :unit,
+    :details, :feetype, :description
+  ]
+end

data/spec/proposal_spec.rb

@@ -0,0 +1,14 @@
+describe Bidsketch::Proposal, vcr: true do
+  it_should_behave_like 'a listable object', Bidsketch::Proposal, [ 
+    :id, :url, :app_url, :created_at, :updated_at,
+    :name, :description, :status, :is_draft
+  ]
+
+  it_should_behave_like 'a findable object',  189362, [
+    :id, :url, :app_url, :created_at, :updated_at,
+    :proposal_date, :name, :description, :status,
+    :is_draft, :user, :currency, :tax, :tax2, :monthly_fees,
+    :yearly_fees, :one_time_fees, :discount, :total,
+    :settings, :client, :content
+  ]
+end

data/spec/section_spec.rb

@@ -0,0 +1,12 @@
+describe Bidsketch::Section, vcr: true do
+  it_should_behave_like 'a listable object', Bidsketch::Section, [
+    :id, :name, :url, :app_url, :created_at, :updated_at,
+    :category, :sectiontype
+  ]   
+
+
+  it_should_behave_like 'a findable object',  390816, [
+    :id, :name, :url, :app_url, :created_at, :updated_at,
+    :category, :sectiontype, :description 
+  ]
+end

data/spec/shared_examples/findable.rb

@@ -0,0 +1,9 @@
+RSpec.shared_examples 'a findable object' do |id, attributes|
+  let(:object) { VCR.use_cassette("#{subject.class.to_s}_#{id}") { subject.class.find(id) } }
+
+  attributes.each do |attribute|
+    it "should return a value for #{attribute}" do
+      expect(object.respond_to?(attribute)).to be true
+    end
+  end
+end

data/spec/shared_examples/listable.rb

@@ -0,0 +1,14 @@
+RSpec.shared_examples 'a listable object' do |subject, attributes = []|
+  let(:list) { VCR.use_cassette(subject.to_s) { subject.all } }
+
+  it "should return an array of objects" do
+    expect(list.class).to eq Array
+    expect(list.first.class).to eq subject
+  end
+
+  attributes.each do |attribute|
+    it "should return a value for #{attribute}" do
+      expect(list.first.respond_to?(attribute)).to be true
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,109 @@
+require 'bidsketch'
+require 'vcr'
+require 'dotenv'
+
+Dotenv.load
+
+# Load shared examples
+Dir['./spec/shared_examples/**/*.rb'].sort.each { |f| require f }
+
+# This file was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# The generated `.rspec` file contains `--require spec_helper` which will cause
+# this file to always be loaded, without a need to explicitly require it in any
+# files.
+#
+# Given that it is always loaded, you are encouraged to keep this file as
+# light-weight as possible. Requiring heavyweight dependencies from this file
+# will add to the boot time of your test suite on EVERY test run, even for an
+# individual file that may not need all of that loaded. Instead, consider making
+# a separate helper file that requires the additional dependencies and performs
+# the additional setup, and require it from the spec files that actually need
+# it.
+#
+# The `.rspec` file also contains a few flags that are not defaults but that
+# users commonly want.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+
+VCR.configure do |c|
+  c.cassette_library_dir = 'spec/fixtures/vcr_cassettes'
+  c.hook_into :webmock
+  c.ignore_localhost = false
+  c.configure_rspec_metadata!
+  c.default_cassette_options = { record: :once }
+end
+
+RSpec.configure do |config|
+  # rspec-expectations config goes here. You can use an alternate
+  # assertion/expectation library such as wrong or the stdlib/minitest
+  # assertions if you prefer.
+  config.expect_with :rspec do |expectations|
+    # This option will default to `true` in RSpec 4. It makes the `description`
+    # and `failure_message` of custom matchers include text for helper methods
+    # defined using `chain`, e.g.:
+    #     be_bigger_than(2).and_smaller_than(4).description
+    #     # => "be bigger than 2 and smaller than 4"
+    # ...rather than:
+    #     # => "be bigger than 2"
+    expectations.include_chain_clauses_in_custom_matcher_descriptions = true
+  end
+
+  # rspec-mocks config goes here. You can use an alternate test double
+  # library (such as bogus or mocha) by changing the `mock_with` option here.
+  config.mock_with :rspec do |mocks|
+    # Prevents you from mocking or stubbing a method that does not exist on
+    # a real object. This is generally recommended, and will default to
+    # `true` in RSpec 4.
+    mocks.verify_partial_doubles = true
+  end
+
+# The settings below are suggested to provide a good initial experience
+# with RSpec, but feel free to customize to your heart's content.
+=begin
+  # These two settings work together to allow you to limit a spec run
+  # to individual examples or groups you care about by tagging them with
+  # `:focus` metadata. When nothing is tagged with `:focus`, all examples
+  # get run.
+  config.filter_run :focus
+  config.run_all_when_everything_filtered = true
+
+  # Limits the available syntax to the non-monkey patched syntax that is
+  # recommended. For more details, see:
+  #   - http://myronmars.to/n/dev-blog/2012/06/rspecs-new-expectation-syntax
+  #   - http://teaisaweso.me/blog/2013/05/27/rspecs-new-message-expectation-syntax/
+  #   - http://myronmars.to/n/dev-blog/2014/05/notable-changes-in-rspec-3#new__config_option_to_disable_rspeccore_monkey_patching
+  config.disable_monkey_patching!
+
+  # This setting enables warnings. It's recommended, but in some cases may
+  # be too noisy due to issues in dependencies.
+  config.warnings = true
+
+  # Many RSpec users commonly either run the entire suite or an individual
+  # file, and it's useful to allow more verbose output when running an
+  # individual spec file.
+  if config.files_to_run.one?
+    # Use the documentation formatter for detailed output,
+    # unless a formatter has already been configured
+    # (e.g. via a command-line flag).
+    config.default_formatter = 'doc'
+  end
+
+  # Print the 10 slowest examples and example groups at the
+  # end of the spec run, to help surface which specs are running
+  # particularly slow.
+  config.profile_examples = 10
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = :random
+
+  # Seed global randomization in this process using the `--seed` CLI option.
+  # Setting this allows you to use `--seed` to deterministically reproduce
+  # test failures related to randomization by passing the same `--seed` value
+  # as the one that triggered the failure.
+  Kernel.srand config.seed
+=end
+end

data/spec/template_spec.rb

@@ -0,0 +1,11 @@
+describe Bidsketch::Template, vcr: true do
+  it_should_behave_like 'a listable object', Bidsketch::Template, [
+    :id, :name, :url, :app_url, :created_at, :updated_at
+  ]   
+
+
+  it_should_behave_like 'a findable object',  121478, [
+    :id, :name, :url, :app_url, :created_at, :updated_at,
+    :sections, :fees
+  ]
+end

metadata

@@ -0,0 +1,146 @@
+--- !ruby/object:Gem::Specification
+name: bidsketch
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Dylan Montgomery
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-06-03 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rest-client
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: queryparams
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: 
+email:
+- mail@citizensinspace.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bidsketch.gemspec
+- lib/bidsketch.rb
+- lib/bidsketch/api.rb
+- lib/bidsketch/bidsketch_object.rb
+- lib/bidsketch/client.rb
+- lib/bidsketch/fee.rb
+- lib/bidsketch/proposal.rb
+- lib/bidsketch/section.rb
+- lib/bidsketch/template.rb
+- lib/bidsketch/version.rb
+- spec/client_spec.rb
+- spec/fee_spec.rb
+- spec/proposal_spec.rb
+- spec/section_spec.rb
+- spec/shared_examples/findable.rb
+- spec/shared_examples/listable.rb
+- spec/spec_helper.rb
+- spec/template_spec.rb
+homepage: https://github.com/citizens/bidsketch-ruby
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.5
+signing_key: 
+specification_version: 4
+summary: Ruby wrapper for the Bidsketch API
+test_files:
+- spec/client_spec.rb
+- spec/fee_spec.rb
+- spec/proposal_spec.rb
+- spec/section_spec.rb
+- spec/shared_examples/findable.rb
+- spec/shared_examples/listable.rb
+- spec/spec_helper.rb
+- spec/template_spec.rb
+has_rdoc: