wordpress-api 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8ee4ce6d2b1c78eaba10a6fe4274cdb32d0dacfd
-  data.tar.gz: 735723ab9c6522c41d812ed3f88d476f95344aac
+  metadata.gz: 6ac01ab9d05af338cd83dad0bb3caf0483a9bb74
+  data.tar.gz: 4362588688c0d7938d14de50ff0333cd9c45d5c9
 SHA512:
-  metadata.gz: 0db0b47608b17f7a100733db8333d0d9a15b940168d44c9252cb6899d662247b4f09a6acfb6ec36cb6324042b4cd1b4a63acdadb4b6fc2d59e412cc633bc15cb
-  data.tar.gz: 2e474fbaeb60b08bc492a1b11ac2c14e03ed2c275712e225ef0cede94b52fdb237b84a2dcc58ed13771766a2d7f79ee6da13b1d4b59160d6c5a64de45949fdf5
+  metadata.gz: 5cf1a57d1555e19d8e0c0bd4b75d33d3ddc875db8055ddf2311d3b779e0fd0e665c0ce5c41530b53120bac8578ee126a8079ae59a0e04aa5724caed071ca14d4
+  data.tar.gz: ab05fc53aef240b9816a26b76f9c5ffb46626e5c4daf91489e7b659f33d325ca2cf7be5dead642c8a55e3b1e12f9c4f3a054226ee18ab4845c5c1dac7ff2ee11

data/lib/wordpress-api.rb

@@ -1,51 +1,156 @@
-require 'open-uri'
+require 'net/http'
 require 'json'
 
 class WordPress
-  def self.hi
-    puts "Hello world!"
-  end
 
   def self.set_source(source)
     @source = source
   end
 
-  def self.get_posts(source, count = nil)
-		unless count.nil?
-			data = open("#{source}posts/")
+  def self.query_url(uri)
+  	begin
+  		data = Net::HTTP.get(uri)
+  	rescue
+  		puts "There was an error with the provided URL: #{uri}"
+  	end
+  end
+
+  def self.prepare_query(params)
+  	args = Hash.new
+  	if params.is_a?(Hash)
+  		params.each{|x| 
+  			filter = "filter[#{x[0]}]";
+  			arg = {filter => x[1]};
+  			args = args.merge(arg);
+  			return args
+  		}
+  	else
+  		raise RuntimeError, "Something is wrong, perhaps you did not pass a hash."
+  	end
+  end
+
+  def self.query_load_json(source, endpoint, params)
+		url = URI("#{source}#{endpoint}/")
+  	if params
+  		args = prepare_query params	
+  		url.query = URI.encode_www_form(args)
+  	end
+  	data = self.query_url(url)
+  	content = JSON.load(data)
+  	return content
+  end
+
+  # Get Posts from a WordPress source
+  #
+  # Requires:
+  # source (str): the url to the root API endpoint
+  # params (hash): a hash of parameters to filter by
+  #
+  # Note, the hash for the params argument should be formed like this:
+  #
+  # params = {'posts_per_page'=>'1','order'=>'ASC'}
+  #
+  # Even though WordPress requires the "filter" argument, we will prepend that
+  # for you in this method.
+  #
+  def self.get_posts(source, params = nil, post = nil)
+		if post.nil?
+			wpposts = self.query_load_json(source, "posts", params)
 		else
-			data = open("#{source}posts/?filter[posts_per_page]=#{count}")
+			wpposts = self.get_post(source, post)
 		end
-		wpposts = JSON.load(data)
 	end
 
 	def self.get_post(source, post)
-		data = open("#{source}posts/#{post}")
-		post = JSON.load(data)
+		posts = self.query_load_json(source, "posts/#{post}", params = nil)
+	end
+
+	# Get Media from a WordPress source
+  #
+  # By default gets the 9 most recent media objects from the WordPress site. If
+  # passed optional parameters, will filter those posts accordingly. Like 
+  # get_posts, this should be passed as a hash. If a specific attachment is 
+  # given as the third parameter, it will return only that attachment's object
+  # and the `params` hash will be ignored (if passed)
+  #
+  # Requires:
+  # source (str): the url to the root API endpoint
+  # attachment (int, optional): a specific attachment to get
+  # params (hash, optional): a hash of parameters to filter by
+  #
+  # Note, the hash for the params argument should be formed like this:
+  #
+  # params = {'posts_per_page'=>'1','order'=>'ASC'}
+  #
+  # Even though WordPress requires the "filter" argument, we will prepend that
+  # for you in this method.
+
+	def self.get_media(source, params = nil, attachment = nil)
+		if attachment
+			posts = get_attachment(source, attachment)
+		else
+			posts = self.query_load_json(source, "media", params)
+		end
 	end
 
-	def self.get_media(source)
-		data = open("#{source}media/")
-		media = JSON.load(data)
+	def self.get_attachment(source, attachment)
+		posts = self.query_load_json(source, "media/#{attachment}")
 	end
 
-	def self.get_taxonomies(source)
-		data = open("#{source}/taxonomies")
-		taxonomies = JSON.load(data)
+	# Get Taxonomies from a WordPress source
+  #
+  # By default, returns all taxonomies registered in the WordPress database.
+  #
+  # If passed a hash of parameters, will filter the taxonomies accordingly. 
+  # (See wp-json documentation at http://wp-api.org/#taxonomies_retrieve-all-taxonomies)
+  #
+  # Requires:
+  # source (str): the url to the root API endpoint
+  #
+  # Optional
+  # attachment (int): a specific attachment to get
+  # params (hash): a hash of parameters to filter by (currently no filters are 
+  #	documented at wp-api.org)
+  #
+  # Note, the hash for the params argument should be formed like this:
+  #
+  # params = {'posts_per_page'=>'1','order'=>'ASC'}
+  #
+  # Even though WordPress requires the "filter" argument, we will prepend that
+  # for you in this method.
+
+	def self.get_taxonomies(source, params = nil, taxonomy = nil)
+		if taxonomy
+			get_taxonomy(source, taxonomy)
+		else
+			taxonomies = self.query_load_json(source, "taxonomies")
+		end
 	end
 	
 	def self.get_taxonomy(source, taxonomy)
-		data = open("#{source}/taxonomies/#{taxonomy}")
-		taxonomy = JSON.load(data)
+		taxonomy = self.query_load_json(source, "taxonomies/#{taxonomy}")
 	end
 
-	def self.get_terms(source, taxonomy)
-		data = open("#{source}/taxonomies/#{taxonomy}/terms")
-		terms = JSON.load(data)
+	# Get terms
+	#
+	# Retrieves all terms associated with a given taxonomy.
+	#
+	# Requires:
+	# source (str): the url to the root API endpoint
+	# taxonomy (str): the taxonomy from which to retrieve terms
+	#
+	# Optional:
+	# term (str): the slug of the term to retrieve
+
+	def self.get_terms(source, taxonomy, term = nil)
+		if term
+			terms = get_term(source, taxonomy, term)
+		else
+			terms = self.query_load_json(source, "/taxonomies/#{taxonomy}/terms")
+		end
 	end
 
-	def self.get_term(source, taxonomy, term)
-		data = open("#{source}/taxonomies/#{taxonomy}/terms/#{term}")
-		term = JSON.load(data)
+	def get_term(source, taxonomy, term)
+		term = self.query_load_json(source, "/taxonomies/#{taxonomy}/terms/#{term}")
 	end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: wordpress-api
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - Greg Boone
@@ -10,8 +10,10 @@ bindir: bin
 cert_chain: []
 date: 2015-01-31 00:00:00.000000000 Z
 dependencies: []
-description: Methods for interfacing with the WordPress API. Currently supports all
-  get requests documented at http://wp-api.org.
+description: |-
+  Methods for interfacing with the WordPress API. Currently
+                     supports all unauthenticated get requests documented at the
+                     WordPress API homepage > http://wp-api.org.
 email: greg@harmsboone.org
 executables: []
 extensions: []