paspartout-api 0.1.0

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    ZDQ0YjJjOTUwZjE4MGNjZDc2OGI1YTc3OTNjZTZkMDM3YWMwOWYzYQ==
+  data.tar.gz: !binary |-
+    YWYyMjAwZjFkYmZhMTI3OGJkNTZlMzg0M2ZlYWNiZmI3YmE3NDcwNw==
+SHA512:
+  metadata.gz: !binary |-
+    NDJkMDk2ODYzNzY4NmI5ZjA4MDQ5MDEwYTkzNGU3ZTBjZWEzM2Q4ZjAyMTRm
+    ZTRmZTJkZDliMmNkNzNmOTIyYzk3ZDBjZTYwMzRhYTEyMTE0OTllZWUzZmM3
+    NGMzZjUxOTdjN2ZlZDY1NmI4ZWZkMDMzOWU5NmI2Y2E2NDhmNmM=
+  data.tar.gz: !binary |-
+    ZGY0YWUwYzYyOTNkMjgzNDMxNWM0NzYyNWE3MDE4ZTQzZWE0MjAzNjhmMjk4
+    MjFlNjFiYTJkNDY5NTBhYWI1ZTg3YjM4ZmYyOWI0Y2FiNTRkNWM0NzUwOWU0
+    ZDJkYzUwMjhiNWI5MzJmMGFkZTlkM2Y0NmZjMzI3OGZhYTMyNmU=

data/.document

@@ -0,0 +1,5 @@
+lib/**/*.rb
+bin/*
+- 
+features/**/*.feature
+LICENSE.txt

data/Gemfile

@@ -0,0 +1,12 @@
+source 'http://rubygems.org'
+
+gem 'httparty', '~> 0.12.0'
+gem 'hashie', '~> 2.0.5'
+
+group :development do
+	gem 'rspec', '~> 2.14.1'
+  gem 'rdoc', '~> 3.12'
+  gem 'bundler', '~> 1.0'
+  gem 'jeweler', '~> 1.8.7'
+  gem 'simplecov', '~> 0.8.2'
+end

data/Gemfile.lock

@@ -0,0 +1,75 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    addressable (2.3.5)
+    builder (3.2.2)
+    diff-lcs (1.2.5)
+    docile (1.1.1)
+    faraday (0.8.8)
+      multipart-post (~> 1.2.0)
+    git (1.2.6)
+    github_api (0.10.1)
+      addressable
+      faraday (~> 0.8.1)
+      hashie (>= 1.2)
+      multi_json (~> 1.4)
+      nokogiri (~> 1.5.2)
+      oauth2
+    hashie (2.0.5)
+    highline (1.6.20)
+    httparty (0.12.0)
+      json (~> 1.8)
+      multi_xml (>= 0.5.2)
+    httpauth (0.2.0)
+    jeweler (1.8.8)
+      builder
+      bundler (~> 1.0)
+      git (>= 1.2.5)
+      github_api (= 0.10.1)
+      highline (>= 1.6.15)
+      nokogiri (= 1.5.10)
+      rake
+      rdoc
+    json (1.8.1)
+    jwt (0.1.8)
+      multi_json (>= 1.5)
+    multi_json (1.8.2)
+    multi_xml (0.5.5)
+    multipart-post (1.2.0)
+    nokogiri (1.5.10)
+    oauth2 (0.9.2)
+      faraday (~> 0.8)
+      httpauth (~> 0.2)
+      jwt (~> 0.1.4)
+      multi_json (~> 1.0)
+      multi_xml (~> 0.5)
+      rack (~> 1.2)
+    rack (1.5.2)
+    rake (10.1.1)
+    rdoc (3.12.2)
+      json (~> 1.4)
+    rspec (2.14.1)
+      rspec-core (~> 2.14.0)
+      rspec-expectations (~> 2.14.0)
+      rspec-mocks (~> 2.14.0)
+    rspec-core (2.14.7)
+    rspec-expectations (2.14.4)
+      diff-lcs (>= 1.1.3, < 2.0)
+    rspec-mocks (2.14.4)
+    simplecov (0.8.2)
+      docile (~> 1.1.0)
+      multi_json
+      simplecov-html (~> 0.8.0)
+    simplecov-html (0.8.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.0)
+  hashie (~> 2.0.5)
+  httparty (~> 0.12.0)
+  jeweler (~> 1.8.7)
+  rdoc (~> 3.12)
+  rspec (~> 2.14.1)
+  simplecov (~> 0.8.2)

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2014 Wout Fierens
+
+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,55 @@
+# paspartout-api
+
+An abstraction layer for the Paspartout API.
+
+## Installation
+
+Use RubyGems to install paspartout-api to get started:
+
+		$ gem install paspartout-api
+
+## Initialization
+
+Use the API key of the Paspartout site, found in the settings panel, to establish the connection:
+
+		@paspartout = Paspartout.new('ppt-247400')
+
+## Pulling data
+
+Get the site data:
+
+		@site = @paspartout.site
+
+Get pages in menu:
+		
+		@pages = @paspartout.pages
+
+Get a particular page including children or blocks:
+
+		@page = @paspartout.page(123)
+
+This also works with the permaname:
+
+		@page = @paspartout.page('page-permaname')
+
+There are some comvenience methods:
+		
+		@portfolio = @paspartout.portfolio
+		@blog = @paspartout.blog
+		@shop = @paspartout.shop
+		@about = @paspartout.about
+
+
+## Contributing to paspartout-api
+ 
+* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet.
+* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it.
+* Fork the project.
+* Start a feature/bugfix branch.
+* Commit and push until you are happy with your contribution.
+* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
+* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
+
+## Copyright
+
+Copyright (c) 2014 Wout Fierens. See LICENSE.txt for further details.

data/Rakefile

@@ -0,0 +1,53 @@
+# encoding: utf-8
+
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'rake'
+
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
+  gem.name = "paspartout-api"
+  gem.homepage = "http://github.com/wout/paspartout-api"
+  gem.license = "MIT"
+  gem.summary = %Q{An abstraction layer for the Paspartout API}
+  gem.description = %Q{An abstraction layer for the Paspartout API}
+  gem.email = "wout@impinc.co.uk"
+  gem.authors = ["wout"]
+  # dependencies defined in Gemfile
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+# require 'rake/testtask'
+# Rake::TestTask.new(:test) do |test|
+#   test.libs << 'lib' << 'spec'
+#   test.pattern = 'spec/**/*_spec.rb'
+#   test.verbose = true
+# end
+
+# require 'rcov/rcovtask'
+# Rcov::RcovTask.new do |test|
+#   test.libs << 'test'
+#   test.pattern = 'test/**/test_*.rb'
+#   test.verbose = true
+#   test.rcov_opts << '--exclude "gems/*"'
+# end
+
+task :default => :test
+
+require 'rdoc/task'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "paspartout-api #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/lib/paspartout-api.rb

@@ -0,0 +1,70 @@
+require 'httparty'
+require 'hashie'
+
+class Paspartout
+  
+  def initialize api_key
+    @api_key = api_key
+    @loaded  = {}
+  end
+
+  def errors
+    @errors
+  end
+
+  def loaded?
+    @errors.empty?
+  end
+
+  def site
+    return @loaded[:site] if @loaded[:site]
+
+    if result = get
+      @loaded[:site] = result
+    end
+  end
+
+  def pages
+    return @loaded[:pages] if @loaded[:pages]
+
+    if result = get('/pages')
+      @loaded[:pages] = result
+    end
+  end
+
+  def page id
+    return @loaded[:"page_#{ id }"] if @loaded[:"page_#{ id }"]
+
+    if result = get("/pages/#{ id }")
+      @loaded[:"page_#{ id }"] = result
+    end
+  end
+
+  %w[ portfolio about blog shop ].each do |m|
+    define_method m do
+      return @loaded[:"#{ m }"] if @loaded[:"#{ m }"]
+
+      pages.each { |p| @loaded[:"#{ m }"] = page(p.id) if p.type == m }
+
+      @loaded[:"#{ m }"]
+    end
+  end
+  
+private
+  
+  def get path = ''
+    @errors = []
+    
+    request = HTTParty.get("http://api.paspartout.com/public/v2/#{ @api_key }#{ path }.json")
+    result  = Hashie::Mash.new({ body: JSON.parse(request.body) })
+    
+    if result.error
+      @errors.push(result.error)
+
+      false
+    else
+      result.body
+    end
+  end
+
+end

data/spec/helper.rb

@@ -0,0 +1,14 @@
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'rspec'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'paspartout-api'

data/spec/paspartout-api_spec.rb

@@ -0,0 +1,91 @@
+require 'helper'
+
+describe Paspartout do
+
+	before do
+	  @paspartout = Paspartout.new('ppt-247400')
+	end
+
+	describe '#errors' do
+
+		it 'fails for non existant sites' do
+			@page = @paspartout.page(0)
+
+			@page.error.code.should be(404)
+		end
+
+	end
+
+  describe '#site' do
+
+  	it 'loads the site' do
+  	  @paspartout.site.subdomain.should eq('gmc')
+  	end
+
+  end
+
+  describe '#pages' do
+
+  	it 'loads pages' do
+  	  @paspartout.pages.size.should be > 0
+  	end
+
+  end
+
+  describe '#page' do
+
+  	it 'loads a given page by id' do
+  		@paspartout.page(3077).type.should eq 'portfolio'
+  	end
+
+  	it 'loads a given page by permaname' do
+  		@paspartout.page('portfolio').id.should be 3077
+  	end
+
+  end
+
+  describe '#portfolio' do
+
+  	it 'loads the portfolio page' do
+  		@paspartout.portfolio.id.should be 3077
+  	end
+
+  	it 'includes children' do
+  		@paspartout.portfolio.children.any?.should be true
+  	end
+
+  end
+
+  describe '#blog' do
+
+  	it 'loads the blog page' do
+  		@paspartout.blog.id.should be 3079
+  	end
+
+  	it 'includes children' do
+  		@paspartout.blog.children.any?.should be true
+  	end
+
+  end
+
+  describe '#about' do
+
+  	it 'loads the about page' do
+  		@paspartout.about.id.should be 3078
+  	end
+
+  end
+
+  describe '#shop' do
+
+  	it 'loads the shop page' do
+  		@paspartout.shop.id.should be 6026
+  	end
+
+  	it 'includes children' do
+  		@paspartout.shop.children.any?.should be true
+  	end
+
+  end
+
+end

metadata

@@ -0,0 +1,153 @@
+--- !ruby/object:Gem::Specification
+name: paspartout-api
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- wout
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-01-01 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: hashie
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.0.5
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.0.5
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.14.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.14.1
+- !ruby/object:Gem::Dependency
+  name: rdoc
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.12'
+- !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: jeweler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.8.7
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.8.7
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.8.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.8.2
+description: An abstraction layer for the Paspartout API
+email: wout@impinc.co.uk
+executables: []
+extensions: []
+extra_rdoc_files:
+- LICENSE.txt
+- README.md
+files:
+- .document
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- VERSION
+- lib/paspartout-api.rb
+- spec/helper.rb
+- spec/paspartout-api_spec.rb
+homepage: http://github.com/wout/paspartout-api
+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.1.9
+signing_key: 
+specification_version: 4
+summary: An abstraction layer for the Paspartout API
+test_files: []