theguardian 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 2a32db6465bd9c8c8476d3495c6d33dcbe748dcc
+  data.tar.gz: 4972b9caff04c4d5704488708081960277fc5c51
+SHA512:
+  metadata.gz: 35a851414b0f3389a81ef5b87abaa0f209c2261be5e2bb812e7e84c3627fbbe3bd0c36ea6306f7c515d78c8628877bf7048ad0bd72940bb9580ea41f466b26c6
+  data.tar.gz: 78fe846497fcf4b80a33d53a8b5669bf273dc4fab4ea462b62c74116f44e062c93801fdc0f948b05099cb12e1899a5d805345784bda7a811f8cc21f52e78ea1a

data/.gitignore

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

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format progress

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Mohamed Magdy
+
+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,29 @@
+# Theguardian
+
+TODO: Write a gem description
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'theguardian'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install theguardian
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Contributing
+
+1. Fork it
+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 new Pull Request

data/Rakefile

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

data/lib/theguardian.rb

@@ -0,0 +1,23 @@
+require "theguardian/version"
+
+# JSON
+require "json"
+
+# REST Client
+require "rest_client"
+
+# Addressable
+require "addressable/uri"
+
+# OpenStruct
+require "recursive-open-struct"
+
+# TheGuardian connection file
+require "theguardian/connection"
+
+# TheGuardian API files
+require "theguardian/content_api"
+require "theguardian/api/search"
+require "theguardian/api/tag"
+require "theguardian/api/section"
+require "theguardian/api/item"

data/lib/theguardian/api/item.rb

@@ -0,0 +1,31 @@
+module Theguardian
+	module Api
+		class Item < RecursiveOpenStruct
+			def initialize(*params)
+				content = params.first["content"] ? params.first.merge(params.first["content"]["fields"] ) : params.first
+				item_params = params.first["fields"] || content
+
+				super(item_params, params.last)
+			end
+
+			def self.process(params)
+				connection = Theguardian::Connection.new(resource: params.delete(:id))
+				self.new(connection.get(self.process_params(params)), recurse_over_arrays: true)
+			end
+
+			def fetch
+				self.class.process({ id: URI(self.apiUrl).path })
+			end
+
+			def self.process_params(params)
+				# The item id
+				theguardian_api_params = { id: params[:id] }
+
+				# The show fields
+				theguardian_api_params.merge!({ "show-fields" => params[:fields] || "all" }) 
+
+				theguardian_api_params.reject{ |_, value| value.nil? }
+			end
+		end
+	end
+end

data/lib/theguardian/api/search.rb

@@ -0,0 +1,54 @@
+module Theguardian
+	module Api
+		class Search < RecursiveOpenStruct
+			def self.process(params = {})
+				connection = Theguardian::Connection.new(resource: "search")
+				params = self.process_params(params)
+
+				self.new(connection.get(params), recurse_over_arrays: true)
+			end
+
+			def items
+				self.results.map do |result| 
+					Theguardian::Api::Item.new(result.to_h) 
+				end
+			end
+
+			def self.process_params(params)
+				theguardian_api_params = { q: params[:q] }
+
+				# Date
+				if params.has_key?(:date)
+					if params[:date].has_key?(:from)
+						theguardian_api_params.merge!({ "from-date" => params[:date][:from].strftime("%Y-%m-%d") })
+					end
+
+					if params[:date].has_key?(:to)
+						theguardian_api_params.merge!({ "to-date" => params[:date][:to].strftime("%Y-%m-%d") })
+					end
+				end
+
+				# Tags
+	 			theguardian_api_params.merge!({ "tag" => params[:tags].join(",") }) if params.has_key?(:tags)
+
+	 			# Sections
+	 			theguardian_api_params.merge!({ "section" => params[:sections].join(",") }) if params.has_key?(:sections) 
+	 			
+	 			# Shown fields
+	 			theguardian_api_params.merge!({ "show-fields" => params[:fields].join(",") }) if params[:fields]
+	 	
+	 			# Refinements
+	 			theguardian_api_params.merge!({ "show-refinements" => params[:refinements].join(",") }) if params.has_key?(:refinements)
+
+	 			# Ordering
+	 			theguardian_api_params.merge!({ "order-by" => params[:order_by] }) if params.has_key?(:order_by)
+
+	 			# Pagination
+	 			theguardian_api_params.merge!({ "page" => params[:page] }) if params.has_key?(:page)
+	 			theguardian_api_params.merge!({ "page-size" => params[:per_page] }) if params.has_key?(:per_page)
+
+	 			theguardian_api_params.reject{ |_, value| value.nil? }
+			end
+		end
+	end
+end

data/lib/theguardian/api/section.rb

@@ -0,0 +1,32 @@
+module Theguardian
+	module Api
+		class Section < RecursiveOpenStruct
+			def self.process(params = {})
+				connection = Theguardian::Connection.new(resource: params[:id] || "sections")
+				response = connection.get
+
+				if params[:id]
+					self.new(response, recurse_over_arrays: true)
+				else
+					response["results"].map do |section_params|
+						self.new(section_params, recurse_over_arrays: true)
+					end
+				end
+			end
+
+			def items
+				self.results.map do |item_params|
+					Theguardian::Api::Item.new(item_params, recurse_over_arrays: true)
+				end
+			end
+
+			def fetch
+				self.class.process(id: self.id)
+			end
+
+			def self.process_params(params)
+				params.reject{ |_, value| value.nil? }
+			end
+		end
+	end
+end

data/lib/theguardian/api/tag.rb

@@ -0,0 +1,42 @@
+module Theguardian
+	module Api
+		class Tag < RecursiveOpenStruct
+			def self.process(params = {})
+				connection = Theguardian::Connection.new(resource: "tags")
+				params = self.process_params(params)
+				response = connection.get(params)
+
+				response["results"].map do |tag_params|
+					self.new(tag_params, recurse_over_arrays: true)
+				end
+			end
+
+			def fetch
+				connection = Theguardian::Connection.new(resource: URI(self.apiUrl).path)
+
+				self.class.new(connection.get, recurse_over_arrays: true)
+			end
+
+			def items
+				self.results.map do |item_params|
+					Theguardian::Api::Item.new(item_params, recurse_over_arrays: true)
+				end
+			end
+
+			def section
+				Theguardian::Api::Section.process(id: self.tag.sectionId)
+			end
+
+			def self.process_params(params)
+				# Query string and tag type
+				theguardian_api_params = { q: params[:q], type: params[:type] }
+
+	 			# Pagination
+	 			theguardian_api_params.merge!({ "page" => params[:page] }) if params.has_key?(:page)
+	 			theguardian_api_params.merge!({ "page-size" => params[:per_page] }) if params.has_key?(:per_page)
+
+	 			theguardian_api_params.reject{ |_, value| value.nil? }
+			end
+		end
+	end
+end

data/lib/theguardian/connection.rb

@@ -0,0 +1,21 @@
+module Theguardian
+	class Connection
+		attr_accessor :url, :resource
+
+		def initialize(params = {})
+			@resource = params[:resource]
+			@url = params[:url] || "http://content.guardianapis.com"
+		end
+
+		def get(params = {})
+			addressable = Addressable::URI.new
+			addressable.query_values = params.merge({ format: "JSON" })
+			p "#{@url}/#{resource}?#{addressable.query}", "==="
+			self.parse(RestClient.get("#{@url}/#{resource}?#{addressable.query}"))
+		end
+
+		def parse(response)
+			JSON.parse(response)["response"]
+		end
+	end
+end

data/lib/theguardian/content_api.rb

@@ -0,0 +1,19 @@
+module Theguardian
+	class ContentApi	
+		def self.search(params = {})
+			Theguardian::Api::Search.process(params)
+		end
+
+		def self.search_tags(params = {})
+			Theguardian::Api::Tag.process(params)
+		end
+
+		def self.sections
+			Theguardian::Api::Section.process
+		end
+
+		def self.item(params)
+			Theguardian::Api::Item.process(params)
+		end	
+	end
+end

data/lib/theguardian/version.rb

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

data/spec/spec_helper.rb

@@ -0,0 +1,7 @@
+require "rubygems"
+require "bundler/setup"
+
+require "theguardian"
+
+RSpec.configure do |config|
+end

data/theguardian.gemspec

@@ -0,0 +1,30 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'theguardian/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "theguardian"
+  spec.version       = Theguardian::VERSION
+  spec.authors       = ["Mohamed Magdy"]
+  spec.email         = ["eng.mohamagdy@gmail.com"]
+  spec.description   = "The Guardian Ruby API"
+  spec.summary       = "Get an access to the Guardian API"
+  spec.homepage      = ""
+  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"]
+
+  # Dependencies
+  spec.add_dependency("rest-client")
+  spec.add_dependency("addressable")
+  spec.add_dependency("recursive-open-struct")
+  
+  # Development dependencies
+  spec.add_development_dependency("bundler", "~> 1.3")
+  spec.add_development_dependency("rake")
+  spec.add_development_dependency("rspec")
+end

metadata

@@ -0,0 +1,145 @@
+--- !ruby/object:Gem::Specification
+name: theguardian
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Mohamed Magdy
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-10-06 00:00:00.000000000 Z
+dependencies:
+- !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: addressable
+  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: recursive-open-struct
+  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: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !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'
+description: The Guardian Ruby API
+email:
+- eng.mohamagdy@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/theguardian.rb
+- lib/theguardian/api/item.rb
+- lib/theguardian/api/search.rb
+- lib/theguardian/api/section.rb
+- lib/theguardian/api/tag.rb
+- lib/theguardian/connection.rb
+- lib/theguardian/content_api.rb
+- lib/theguardian/version.rb
+- spec/spec_helper.rb
+- theguardian.gemspec
+homepage: ''
+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.0.3
+signing_key: 
+specification_version: 4
+summary: Get an access to the Guardian API
+test_files:
+- spec/spec_helper.rb