g5_foundation_client 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 105ce37f62316995bc13de1ca695cabc511ae612
+  data.tar.gz: c1c8ff75ed1280e15fc1f43a970ef3bbf138d9e7
+SHA512:
+  metadata.gz: 97a1355895beb3f2c8b57d3a9b911a7bd24c2e08d692a36888e10ba4cd542633d3ba8bb3c684ba0e5895b846d5ebc08688546bebadb73ff02c1697d0838da31f
+  data.tar.gz: 0be6d18fe919210a953ef9146b6c4c6d5f49ed562c6de4dbf6ea9ca82bf5a042ea9e13129265a3a4b2f47ef404fdd0dcad80d6e2fb5b4b192e7e354c47731196

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.rspec

@@ -0,0 +1 @@
+--color

data/.travis.yml

@@ -0,0 +1,9 @@
+language: ruby
+rvm:
+  # Core
+  - 1.9.3
+  # Reputation
+  - 2.0.0
+  # Everybody else
+  - 2.1.1
+script: bundle exec rspec spec

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in g5_foundation_client.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Don Petersen
+
+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,33 @@
+# G5 Foundation Client
+
+[![Build Status](https://travis-ci.org/G5/g5_foundation_client.svg)](https://travis-ci.org/G5/g5_foundation_client)
+
+A Ruby gem to access G5 services, including [g5-hub](https://github.com/g5/g5-hub).
+
+### Installation
+
+Include `g5_foundation_client` in your Gemfile, or manually install with rubygems.
+
+### Usage
+
+It's pretty limited right now. You may fetch a Location given a UID, which must point to a G5 Hub Location detail page.
+
+```ruby
+> model = G5FoundationClient::Location.find_by_uid("http://example.com/clients/g5-c-123-test/locations/g5-cl-123-test")
+=> #<G5FoundationClient::Location:0x007f4aa8c25ef8
+ @name="Location Name",
+ @phone="123-123-1234",
+ @uid=
+  "http://example.com/clients/g5-c-123-test/locations/g5-cl-123-test">
+> model.attributes
+=> {:uid=>
+  "http://example.com/clients/g5-c-123-test/locations/g5-cl-123-test",
+ :name=>"Test Name",
+ :phone=>"123-123-1234"}
+```
+
+If this gets much more complicated – and it will – you should probably use YARD and point to rdoc.info, or whatever documentation builder you set up.
+
+### Contributing
+
+Create a Github pull request. Please make sure that Travis CI passes before you do.

data/Rakefile

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

data/g5_foundation_client.gemspec

@@ -0,0 +1,31 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'g5_foundation_client/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "g5_foundation_client"
+  spec.version       = G5FoundationClient::VERSION
+  spec.authors       = ["Don Petersen"]
+  spec.email         = ["don@donpetersen.net"]
+  spec.summary       = %q{Client gem to interact with G5 services.}
+  spec.description   = %q{Client gem to interact with G5 services.}
+  spec.homepage      = "https://github.com/g5/g5_foundation_client"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  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_dependency "virtus"
+  spec.add_dependency "httparty"
+  spec.add_dependency "microformats2"
+  spec.add_dependency "g5_authentication_client", ">= 0.2"
+
+  spec.add_development_dependency "bundler", "~> 1.5"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "webmock"
+  spec.add_development_dependency "pry"
+end

data/lib/g5_foundation_client/deserializers/location.rb

@@ -0,0 +1,12 @@
+module G5FoundationClient::Deserializers
+  module Location
+    def self.from_markup(markup)
+      hcard = Microformats2.parse(markup).cards.first
+      G5FoundationClient::Location.new(
+        uid: hcard.uid.to_s,
+        name: hcard.name.to_s,
+        phone: hcard.adr.format.tel.to_s
+      )
+    end
+  end
+end

data/lib/g5_foundation_client/fetcher.rb

@@ -0,0 +1,26 @@
+class G5FoundationClient::Fetcher
+  def self.fetch_url(url, &block)
+    response = HTTParty.get(
+      url,
+      { query: { access_token: G5FoundationClient::access_token } }
+    )
+
+    case response.response.code.to_i
+    when 200
+      yield response.body
+    when 404
+      raise G5FoundationClient::RecordNotFoundException.new(
+        "Couldn't find record at URL '#{url}'"
+      )
+    else
+      raise Exception.new(
+        "I got an unexpected response code '#{response.response.code}'"
+      )
+    end
+  end
+
+protected
+
+  def self.query_options
+  end
+end

data/lib/g5_foundation_client/models/location.rb

@@ -0,0 +1,13 @@
+class G5FoundationClient::Location
+  include Virtus.model
+
+  attribute :uid, String
+  attribute :name, String
+  attribute :phone, String
+
+  def self.find_by_uid(uid)
+    G5FoundationClient::Fetcher.fetch_url(uid) do |markup|
+      G5FoundationClient::Deserializers::Location.from_markup(markup)
+    end
+  end
+end

data/lib/g5_foundation_client/record_not_found_exception.rb

@@ -0,0 +1,2 @@
+class G5FoundationClient::RecordNotFoundException < StandardError
+end

data/lib/g5_foundation_client/version.rb

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

data/lib/g5_foundation_client.rb

@@ -0,0 +1,23 @@
+require "virtus"
+require "httparty"
+require "microformats2"
+require "g5_authentication_client"
+require "g5_foundation_client/version"
+
+module G5FoundationClient
+  def self.access_token=(token)
+    @access_token = token
+  end
+
+  def self.access_token
+    @access_token ||= G5AuthenticationClient::Client.new.get_access_token
+  end
+
+  class RecordNotFoundException < Exception
+  end
+end
+
+require 'g5_foundation_client/fetcher'
+
+require 'g5_foundation_client/models/location'
+require 'g5_foundation_client/deserializers/location'

data/spec/fixtures/location_detail.html

@@ -0,0 +1,36 @@
+
+<!DOCTYPE html>
+<html>
+  <head></head>
+  <body>
+    <section class="h-card">
+      <h2>
+        <a class="p-name u-uid u-url" href="http://example.com/clients/g5-c-1234-client/locations/g5-cl-1234-location">Test Location</a>
+      </h2>
+
+      <h4>Domain</h4>
+      <a class="u-url u-g5-domain" href="http://www.examplelocation.com/">http://www.examplelocation.com/</a>
+
+      <h4>Address</h4>
+      <p class="p-adr h-adr">
+        <span class="p-street-address">
+          123 Test Way
+        </span>
+        <span>
+          <span class="p-locality">Testville</span>
+          <span class="p-region">GA</span>
+          <span class="p-postal-code">12345</span>
+        </span>
+        <span class="p-tel">123-123-1234</span>
+        <span class="p-tel p-fax"></span>
+        <span class="u-email"></span>
+      </p>
+
+
+      <h4>Client</h4>
+      <p class="p-org h-card">
+        <a class="p-name u-uid u-url" href="http://example.com/clients/g5-c-1234-client">Test Client</a>
+      </p>
+    </section>
+  </body>
+</html>

data/spec/lib/g5_foundation_client/deserializers/location_spec.rb

@@ -0,0 +1,12 @@
+require 'spec_helper'
+
+describe G5FoundationClient::Deserializers::Location do
+  describe ".from_markup" do
+    let(:markup) { fixture("location_detail.html") }
+    subject { G5FoundationClient::Deserializers::Location.from_markup(markup) }
+
+    its(:uid) { should eq("http://example.com/clients/g5-c-1234-client/locations/g5-cl-1234-location") }
+    its(:name) { should eq("Test Location") }
+    its(:phone) { should eq("123-123-1234") }
+  end
+end

data/spec/lib/g5_foundation_client/fetcher_spec.rb

@@ -0,0 +1,42 @@
+require 'spec_helper'
+
+describe G5FoundationClient::Fetcher do
+  before { G5FoundationClient.access_token = "token" }
+
+  describe ".fetch_url" do
+    let(:url) { "http://example.com/?access_token=token" }
+    subject(:fetch) do
+      yielded_markup = nil
+      G5FoundationClient::Fetcher.fetch_url(url) do |markup|
+        yielded_markup = markup
+      end
+
+      yielded_markup
+    end
+
+    context "when the response is successful" do
+      before { stub_json(url, "markup") }
+      it { should eq("markup") }
+    end
+
+    context "when there is no Location at that UID" do
+      before { stub_json(url, response, 404) }
+      let(:response) { %["<html><body>Something went wrong</body></html>] }
+
+      it "explodes violently" do
+        expect { fetch }.to raise_error(
+          G5FoundationClient::RecordNotFoundException, /example/
+        )
+      end
+    end
+
+    context "when there is an unexpected response" do
+      before { stub_json(url, response, 418) }
+      let(:response) { %[{"error":"I'm a teapot"}] }
+
+      it "explodes violently" do
+        expect { fetch }.to raise_error(/418/)
+      end
+    end
+  end
+end

data/spec/lib/g5_foundation_client/models/location_spec.rb

@@ -0,0 +1,30 @@
+require 'spec_helper'
+
+describe G5FoundationClient::Location do
+  before { G5FoundationClient.access_token = "token" }
+
+  describe "instantiating with a hash" do
+    subject do
+      G5FoundationClient::Location.new(
+        uid: "http://example.com/uid",
+        name: "Test Name",
+        phone: "123-123-1234"
+      )
+    end
+
+    its(:uid) { should eql("http://example.com/uid") }
+    its(:name) { should eql("Test Name") }
+    its(:phone) { should eql("123-123-1234") }
+  end
+
+  describe ".find_by_uid" do
+    let(:uid) do
+      "http://example.com/clients/g5-c-1234-client/locations/g5-cl-1234-location"
+    end
+    let(:response) { fixture("location_detail.html") }
+    before { stub_json(uid + "?access_token=token", response) }
+    subject(:find) { G5FoundationClient::Location.find_by_uid(uid) }
+
+    its(:name) { should eq("Test Location") }
+  end
+end

data/spec/lib/g5_foundation_client_spec.rb

@@ -0,0 +1,23 @@
+require 'spec_helper'
+
+describe G5FoundationClient do
+  describe ".access_token" do
+    subject { G5FoundationClient.access_token }
+
+    context "when it has not been set" do
+      before do
+        G5AuthenticationClient::Client.stub_chain(
+          :new,
+          get_access_token: "fetched access token"
+        )
+      end
+
+      it { should eql("fetched access token") }
+    end
+
+    context "when it has beeen set" do
+      before { G5FoundationClient.access_token = "set access token" }
+      it { should eql("set access token") }
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,46 @@
+require 'g5_foundation_client'
+
+require 'pry'
+require 'webmock/rspec'
+
+module Webmockery
+  def stub_json(url, response, status=200)
+    stub_request(
+      :get,
+      url
+    ).to_return(
+      body: response,
+      status: status,
+      headers: {
+        content_type: 'application/json'
+      }
+    )
+  end
+
+  def stub_post(url, response, data, status=200)
+    stub_request(
+      :post,
+      url
+    ).with(
+      body: data
+    ).to_return(
+      body: response,
+      status: status,
+      headers: {
+        content_type: 'application/json'
+      }
+    )
+  end
+end
+
+module FixturesHelper
+  def fixture(fixture_path)
+    open(File.join("spec", "fixtures", fixture_path)).read
+  end
+end
+
+RSpec.configure do |config|
+  config.include Webmockery
+  config.include FixturesHelper
+  config.after { G5FoundationClient.access_token = nil }
+end

data/wooo.creds

@@ -0,0 +1,6 @@
+ENV["G5_AUTH_CLIENT_ID"] = "88aa19805f81835354be522ff3ff9c44a0c90fbbc3ed4980814a006768333797"
+ENV["G5_AUTH_CLIENT_SECRET"] = "237c83f987a409a2027347bc1ee97c036cc3d9e038fc8db68e7e6ce525955cc5"
+ENV["G5_AUTH_ENDPOINT"] = "https://auth.g5search.com"
+ENV["G5_AUTH_PASSWORD"] = "oaregjoiaergjoierga89489234089imczopuiewrq&@#$%^@UIWECH78623784678328957832NJKHCWUIHCUEKWHEKCHK2u38o2j3aiuwdihla38y29483279482379jcdoajiejc"
+ENV["G5_AUTH_REDIRECT_URI"] = "https://g5-cxm-6d4u4sc-madrona.herokuapp.com/g5_auth/users/auth/g5/callback"
+ENV["G5_AUTH_USERNAME"] = "g5dev+serviceaccount@g5searchmarketing.com"

metadata

@@ -0,0 +1,197 @@
+--- !ruby/object:Gem::Specification
+name: g5_foundation_client
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Don Petersen
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-04-04 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: virtus
+  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: httparty
+  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: microformats2
+  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: g5_authentication_client
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.2'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Client gem to interact with G5 services.
+email:
+- don@donpetersen.net
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- g5_foundation_client.gemspec
+- lib/g5_foundation_client.rb
+- lib/g5_foundation_client/deserializers/location.rb
+- lib/g5_foundation_client/fetcher.rb
+- lib/g5_foundation_client/models/location.rb
+- lib/g5_foundation_client/record_not_found_exception.rb
+- lib/g5_foundation_client/version.rb
+- spec/fixtures/location_detail.html
+- spec/lib/g5_foundation_client/deserializers/location_spec.rb
+- spec/lib/g5_foundation_client/fetcher_spec.rb
+- spec/lib/g5_foundation_client/models/location_spec.rb
+- spec/lib/g5_foundation_client_spec.rb
+- spec/spec_helper.rb
+- wooo.creds
+homepage: https://github.com/g5/g5_foundation_client
+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.0
+signing_key: 
+specification_version: 4
+summary: Client gem to interact with G5 services.
+test_files:
+- spec/fixtures/location_detail.html
+- spec/lib/g5_foundation_client/deserializers/location_spec.rb
+- spec/lib/g5_foundation_client/fetcher_spec.rb
+- spec/lib/g5_foundation_client/models/location_spec.rb
+- spec/lib/g5_foundation_client_spec.rb
+- spec/spec_helper.rb