roqua-core-api 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: abcd3e3f4bf1bd4306cb7e3e6132f408682099df
+  data.tar.gz: aade6681c604c4639e9fa81e13fb994e5aa757e2
+SHA512:
+  metadata.gz: d82f752d2478b8063fedac666b8655710d80abf2c8ce2169cc3b2762e2a780c2271dbe1d68770a59d8b8c8f90446ff3e93167eb2e15652f10dbe6b7767b73ad7
+  data.tar.gz: 97ce5478ac884beb0d334c2ce9be760a2cdb1a32a4bb04e5d975fc205160848559f6b742a97893c1a06e9e0349bfcdbeb321b0c7d6f5836215db6c6c9869580b

data/.document

@@ -0,0 +1,3 @@
+- 
+ChangeLog.md
+LICENSE.txt

data/.gitignore

@@ -0,0 +1,5 @@
+Gemfile.lock
+doc/
+pkg/
+vendor/cache/*.gem
+.yardoc

data/.rspec

@@ -0,0 +1 @@
+--colour --format documentation

data/.yardopts

@@ -0,0 +1 @@
+--markup markdown --title "core_api Documentation" --protected

data/ChangeLog.md

@@ -0,0 +1,5 @@
+### 0.0.1 / 2014-01-28
+
+* Initial release:
+
+Here be dragons

data/Gemfile

@@ -0,0 +1,7 @@
+source 'https://rubygems.org'
+
+gemspec
+
+group :development do
+  gem 'kramdown'
+end

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2014 RoQua
+
+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,28 @@
+# core_api
+
+* [Homepage](https://github.com/marten/core_api#readme)
+* [Issues](https://github.com/marten/core_api/issues)
+* [Documentation](http://rubydoc.info/gems/core_api/frames)
+* [Email](mailto:marten at veldthuis.com)
+
+## Description
+
+TODO: Description
+
+## Features
+
+## Examples
+
+    require 'core_api'
+
+## Requirements
+
+## Install
+
+    $ gem install core_api
+
+## Copyright
+
+Copyright (c) 2014 Marten Veldthuis
+
+See {file:LICENSE.txt} for details.

data/Rakefile

@@ -0,0 +1,33 @@
+# encoding: utf-8
+
+require 'rubygems'
+
+begin
+  require 'bundler'
+rescue LoadError => e
+  warn e.message
+  warn "Run `gem install bundler` to install Bundler."
+  exit -1
+end
+
+begin
+  Bundler.setup(:development)
+rescue Bundler::BundlerError => e
+  warn e.message
+  warn "Run `bundle install` to install missing gems."
+  exit e.status_code
+end
+
+require 'rake'
+
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new
+
+task :test    => :spec
+task :default => :spec
+
+require "bundler/gem_tasks"
+
+require 'yard'
+YARD::Rake::YardocTask.new  
+task :doc => :yard

data/core_api.gemspec

@@ -0,0 +1,28 @@
+# -*- encoding: utf-8 -*-
+
+require File.expand_path('../lib/roqua/core_api/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.name          = "roqua-core-api"
+  gem.version       = Roqua::CoreApi::VERSION
+  gem.summary       = %q{API wrapper gem around Core's API}
+  gem.description   = %q{Provides authenticated access to Core}
+  gem.license       = "MIT"
+  gem.authors       = ["Marten Veldthuis"]
+  gem.email         = "marten@veldthuis.com"
+  gem.homepage      = "https://github.com/roqua/core/blob/master/core_api/README.markdown"
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ['lib']
+
+  gem.add_dependency 'httparty', '~> 0.12.0'
+
+  gem.add_development_dependency 'bundler', '~> 1.0'
+  gem.add_development_dependency 'rake', '~> 10.0'
+  gem.add_development_dependency 'rspec', '~> 3.0.0.beta1'
+  gem.add_development_dependency 'yard', '~> 0.8'
+  gem.add_development_dependency 'vcr', '~> 2.8.0'
+  gem.add_development_dependency 'webmock', '~> 1.17.1'
+end

data/lib/roqua-core-api.rb

@@ -0,0 +1 @@
+require 'roqua/core_api'

data/lib/roqua/core_api.rb

@@ -0,0 +1,5 @@
+require 'roqua/core_api/version'
+require 'roqua/core_api/models'
+require 'roqua/core_api/sessions'
+
+Roqua::CoreApi::Models::Dossier

data/lib/roqua/core_api/models.rb

@@ -0,0 +1,2 @@
+require 'roqua/core_api/models/organization'
+require 'roqua/core_api/models/dossier'

data/lib/roqua/core_api/models/dossier.rb

@@ -0,0 +1,15 @@
+module Roqua
+  module CoreApi
+    module Models
+      class Dossier
+        def initialize(attributes)
+          @attributes = attributes
+        end
+
+        def id
+          @attributes.fetch("id")
+        end
+      end
+    end
+  end
+end

data/lib/roqua/core_api/models/organization.rb

@@ -0,0 +1,19 @@
+module Roqua
+  module CoreApi
+    module Models
+      class Organization
+        def initialize(attributes)
+          @attributes = attributes
+        end
+
+        def key
+          @attributes.fetch("key")
+        end
+
+        def name
+          @attributes.fetch("name")
+        end
+      end
+    end
+  end
+end

data/lib/roqua/core_api/sessions.rb

@@ -0,0 +1 @@
+require 'roqua/core_api/sessions/app_session'

data/lib/roqua/core_api/sessions/app_session.rb

@@ -0,0 +1,41 @@
+require 'httparty'
+
+module Roqua
+  module CoreApi
+    module Sessions
+      # AppSession represents a session which is scoped to a specific app
+      # in the Core database. It deals with managing organizations and dossiers,
+      # but only on a anonymous base. It is not allowed to know who these dossiers
+      # represent.
+      class AppSession
+        include HTTParty
+        base_uri ENV["CORE_URL"]
+
+        attr_reader :key
+
+        def initialize(key)
+          @key = key
+        end
+
+        def create_organization(attributes)
+          response = post "/organizations", organization: attributes
+          raise response.inspect unless response.code == 201
+          Models::Organization.new(response)
+        end
+
+        def create_dossier(organization, attributes)
+          response = post "/organizations/#{organization.key}/dossiers", dossier: attributes
+          raise response.inspect unless response.code == 201
+          Models::Dossier.new(response)
+        end
+
+        private
+
+        def post(url, params = {})
+          # TODO: Handle authentication here
+          self.class.post("/apps/#{key}" + url + ".json", body: params)
+        end
+      end
+    end
+  end
+end

data/lib/roqua/core_api/version.rb

@@ -0,0 +1,5 @@
+module Roqua
+  module CoreApi
+    VERSION = "0.0.1"
+  end
+end

data/spec/core_api_spec.rb

@@ -0,0 +1,7 @@
+require 'spec_helper'
+
+describe Roqua::CoreApi do
+  it "should have a VERSION constant" do
+    expect(subject.const_get('VERSION')).to_not be_empty
+  end
+end

data/spec/fixtures/Organizations/can_be_created.yml

@@ -0,0 +1,50 @@
+---
+http_interactions:
+- request:
+    method: post
+    uri: http://core.dev/apps/development/organizations.json
+    body:
+      encoding: UTF-8
+      string: organization[key]=foobar&organization[name]=Foo%20Bar
+    headers: {}
+  response:
+    status:
+      code: 201
+      message: Created
+    headers:
+      Date:
+      - Tue, 28 Jan 2014 14:04:59 GMT
+      Server:
+      - Apache/2.2.24 (Unix) DAV/2 Phusion_Passenger/4.0.35 mod_ssl/2.2.24 OpenSSL/0.9.8y
+      X-Frame-Options:
+      - SAMEORIGIN
+      X-Xss-Protection:
+      - 1; mode=block
+      X-Content-Type-Options:
+      - nosniff
+      X-Ua-Compatible:
+      - chrome=1
+      Etag:
+      - "\"304439f64ca0ad5b9042da7c93ee58d2\""
+      Cache-Control:
+      - max-age=0, private, must-revalidate
+      X-Request-Id:
+      - a3f0d5c5-6118-4277-8bc3-f88344a5e8da
+      X-Runtime:
+      - '0.009867'
+      X-Powered-By:
+      - Phusion Passenger 4.0.35
+      Location:
+      - http://core.dev/apps/1/organizations/5
+      Status:
+      - 201 Created
+      Transfer-Encoding:
+      - chunked
+      Content-Type:
+      - application/json; charset=utf-8
+    body:
+      encoding: UTF-8
+      string: "{\"id\":5,\"key\":\"foobar\",\"name\":\"Foo Bar\",\"created_at\":\"2014-01-28T14:04:59.261Z\",\"updated_at\":\"2014-01-28T14:04:59.261Z\",\"app_id\":1}"
+    http_version: 
+  recorded_at: Tue, 28 Jan 2014 14:04:59 GMT
+recorded_with: VCR 2.8.0

data/spec/integration/organizations_spec.rb

@@ -0,0 +1,11 @@
+require 'spec_helper'
+
+describe 'Organizations' do
+  let(:session) { Sessions::AppSession.new('development') }
+
+  it 'can be created', :vcr do
+    organization = session.create_organization(key: 'foobar', name: 'Foo Bar')
+    expect(organization.key).to eq("foobar")
+    expect(organization.name).to eq("Foo Bar")
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,11 @@
+require 'rspec'
+
+require 'vcr'
+VCR.configure do |c|
+  c.cassette_library_dir = 'spec/fixtures'
+  c.hook_into :webmock
+  c.configure_rspec_metadata!
+end
+
+require 'roqua-core-api'
+include Roqua::CoreApi

metadata

@@ -0,0 +1,168 @@
+--- !ruby/object:Gem::Specification
+name: roqua-core-api
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Marten Veldthuis
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-01-28 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.12.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.12.0
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !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: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.0.0.beta1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.0.0.beta1
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+- !ruby/object:Gem::Dependency
+  name: vcr
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.8.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.8.0
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.17.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.17.1
+description: Provides authenticated access to Core
+email: marten@veldthuis.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".document"
+- ".gitignore"
+- ".rspec"
+- ".yardopts"
+- ChangeLog.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- core_api.gemspec
+- lib/roqua-core-api.rb
+- lib/roqua/core_api.rb
+- lib/roqua/core_api/models.rb
+- lib/roqua/core_api/models/dossier.rb
+- lib/roqua/core_api/models/organization.rb
+- lib/roqua/core_api/sessions.rb
+- lib/roqua/core_api/sessions/app_session.rb
+- lib/roqua/core_api/version.rb
+- spec/core_api_spec.rb
+- spec/fixtures/Organizations/can_be_created.yml
+- spec/integration/organizations_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/roqua/core/blob/master/core_api/README.markdown
+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.2.1
+signing_key: 
+specification_version: 4
+summary: API wrapper gem around Core's API
+test_files:
+- spec/core_api_spec.rb
+- spec/fixtures/Organizations/can_be_created.yml
+- spec/integration/organizations_spec.rb
+- spec/spec_helper.rb
+has_rdoc: