tpex 0.1.6

data/lib/tpex/client/products.rb

@@ -0,0 +1,69 @@
+require "json"
+
+module TPEX
+	class Client
+		module Products
+
+			FIELDS = {
+				manufacturer: {machine_name: "manufacturer"},
+				certified: {machine_name: "field_certified", required: true},
+				tags: {machine_name: "field_tags", required: true, label:"tid"},
+				model_no: {machine_name: "field_model_num", required: true, enclosed: true},
+				brand: {machine_name: "field_product_brand", required: true, enclosed: true},
+				product_line: {machine_name: "field_product_line_family_name", enclosed: true},
+				femp: {machine_name: "field_femp", required: true},
+				upc: {machine_name: "field_universal_product_code_upc"},
+				energy_star_no: {machine_name: "field_energy_star_specification_", enclosed: true},
+				uuid: {machine_name: "uuid"}
+			}
+
+			Product =  Struct.new(*FIELDS.keys)
+
+			# def get_product_by_uuid()
+
+			# end
+
+			def post_product(product)
+				data = jsonify_product(product)
+				response = post("content", data)
+			end
+
+			def build_product(options={})
+				required_fields = []
+				arguments = []
+
+				TPEX::Client::Products::FIELDS.each do |key, value|
+					required_fields << key if value[:required]
+					arguments << options[key]
+				end
+
+				required_fields.each do |key|
+					return nil if options[key].nil?
+				end
+
+				return Product.new(*arguments);
+			end
+
+			def jsonify_product(product)
+			    if !product[:uuid].nil?
+					jsonobject = {"title" => "Json Object", "uuid" => product[:uuid]}
+				else
+					jsonobject = {"title" => "Json Object"}
+				end
+				fields = TPEX::Client::Products::FIELDS
+
+				product.each_pair do |name, value|
+					if name != :uuid
+						if !value.nil?
+							label = fields[name][:label] || "value"
+							contents = {label => value}
+							contents = [{label => value}] if fields[name][:enclosed]
+							jsonobject[fields[name][:machine_name]] = {"und" => contents}
+						end
+					end
+				end
+				JSON.generate({"product" => jsonobject})
+			end
+		end
+	end
+end

data/lib/tpex/configuration.rb

@@ -0,0 +1,64 @@
+require 'faraday'
+require File.expand_path('../version', __FILE__)
+
+module TPEX
+	module Configuration
+
+    	VALID_OPTIONS_KEYS =  [
+    		:username,
+    		:password,
+    		:access_token,
+    		:endpoint,
+            :access_endpoint,
+    		:format,
+    		:user_agent,
+    		:cookie,
+            :logging
+    	].freeze
+
+    	VALID_FORMATS = [
+          :json
+        ].freeze
+
+        # Default config values
+        DEFAULT_FORMAT = :json
+        DEFAULT_USERNAME = nil
+        DEFAULT_PASSWORD = nil
+        DEFAULT_ACCESS_TOKEN = nil
+        DEFAULT_ENDPOINT = 'http://aw.concept3ddev.com/tpex/test_endpoint'
+        DEFAULT_USER_AGENT = "TPEX Ruby Client #{TPEX::VERSION}".freeze
+        DEFAULT_COOKIE = nil
+        DEFAULT_LOGGING = nil
+
+		attr_accessor *VALID_OPTIONS_KEYS
+
+        # When this module is extended, set all configuration options to their default values
+        def self.extended(base)
+          base.reset
+        end
+
+        # Convenience method to allow configuration options to be set in a block
+        def configure
+          yield self
+        end
+
+        # Create a hash of options and their values
+        def options
+          VALID_OPTIONS_KEYS.inject({}) do |option, key|
+            option.merge!(key => send(key))
+          end
+        end
+
+        # Reset all configuration options to defaults
+        def reset
+    	    self.format = DEFAULT_FORMAT
+    	    self.username = DEFAULT_USERNAME
+    	    self.password = DEFAULT_PASSWORD
+    	    self.access_token = DEFAULT_ACCESS_TOKEN
+    	    self.endpoint = DEFAULT_ENDPOINT
+    	    self.user_agent = DEFAULT_USER_AGENT
+    	    self.cookie = DEFAULT_COOKIE
+            self.logging = DEFAULT_LOGGING
+        end
+	end
+end

data/lib/tpex/connection.rb

@@ -0,0 +1,33 @@
+require 'faraday_middleware'
+Dir[File.expand_path('../../faraday/*.rb', __FILE__)].each{|f| require f}
+
+module TPEX
+  # @private
+  module Connection
+
+    # private
+
+    def connection(raw=false)
+
+      options = {
+        :headers => {
+          'Accept' => "application/#{format}; charset=utf-8",
+          'User-Agent' => user_agent,
+          'Cookie' => cookie,
+          'X-CSRF-Token' => access_token
+        }.reject{ |k,v| v.nil? },
+        :ssl => {:verify => false},
+        :url => endpoint,
+      }
+
+      Faraday::Connection.new(options) do |c|
+        c.use FaradayMiddleware::Mashify unless raw
+        c.response :json, :content_type => /\bjson$/
+        c.response :logger if @logging
+        c.use FaradayMiddleware::RaiseHttpException
+        c.adapter Faraday.default_adapter
+
+      end
+    end
+  end
+end

data/lib/tpex/error.rb

@@ -0,0 +1,21 @@
+module TPEX
+  class Error < StandardError; end
+
+  # For 400's
+  class BadRequest < Error; end
+
+  # For 401's
+  class Unauthorized < Error; end
+
+  # For 404's.
+  class NotFound < Error; end
+
+  # For 406's.
+  class NotAcceptable < Error; end
+
+  # For 500's
+  class InternalServerError < Error; end
+
+
+
+end

data/lib/tpex/request.rb

@@ -0,0 +1,39 @@
+module TPEX
+  module Request
+    # Perform an HTTP GET request
+    def get(path, options={}, raw=false, unformatted=false, no_response_wrapper=false)
+      request(:get, path, options, raw, unformatted, no_response_wrapper)
+    end
+
+    # Perform an HTTP POST request
+    def post(path, options={}, raw=false, unformatted=false, no_response_wrapper=false)
+      request(:post, path, options, raw, unformatted, no_response_wrapper)
+    end
+
+    private
+
+    # Perform an HTTP request
+    def request(method, path, options, raw=false, unformatted=false, no_response_wrapper=false)
+      response = connection(raw).send(method) do |request|
+        path = formatted_path(path) unless unformatted
+
+        case method
+        when :get, :delete
+          request.url(path, options)
+        when :post, :put
+          request.path = path
+          request.body = options unless options.empty?
+        end
+
+        request.headers['Content-Type'] = 'application/json'
+      end
+      return response if raw
+      return response.body if no_response_wrapper
+      return Response.create( response.body )
+    end
+
+    def formatted_path(path)
+      [path, format].compact.join('.')
+    end
+  end
+end

data/lib/tpex/response.rb

@@ -0,0 +1,9 @@
+module TPEX
+  module Response
+    def self.create( response_hash )
+      data = response_hash.data.dup rescue response_hash
+      data.extend( self )
+      data
+    end
+  end
+end

data/lib/tpex/servicescsrf.rb

@@ -0,0 +1,11 @@
+module TPEX
+	module ServicesCSRF
+
+		# Returns a token used in the X-CSRF-Token header, to prevent
+		# cross-site request forgeries
+		def get_access_token(options={})
+			post("/services/session/token", options={}, raw=false, unformatted=true, no_response_wrapper=true)
+		end
+
+	end
+end

data/lib/tpex/version.rb

@@ -0,0 +1,9 @@
+module TPEX
+
+  VERSION = "0.1.6"
+
+  def self.version
+    VERSION
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,17 @@
+# This file was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# Require this file using `require "spec_helper"` to ensure that it is only
+# loaded once.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+RSpec.configure do |config|
+  config.treat_symbols_as_metadata_keys_with_true_values = true
+  config.run_all_when_everything_filtered = true
+  config.filter_run :focus
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = 'random'
+end

metadata

@@ -0,0 +1,123 @@
+--- !ruby/object:Gem::Specification
+name: tpex
+version: !ruby/object:Gem::Version
+  version: 0.1.6
+platform: ruby
+authors:
+- Katherine Fleming
+- Francisco Rodriguez
+- Daniel Studer
+- Nicholas Long
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-12-10 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: faraday
+  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: faraday_middleware
+  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: pry
+  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: json
+  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'
+description: This gem allows for the creation of product and performance nodes on
+  the TPE website.
+email: katherine.fleming@nrel.gov
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.rdoc
+- lib/faraday/raise_http_exception.rb
+- lib/ponse = client.post_performance_node(perf)
+- lib/tpex/api.rb
+- lib/tpex/client/auth.rb
+- lib/tpex/client/fields.txt
+- lib/tpex/client/files.rb
+- lib/tpex/client/performancenodes.rb
+- lib/tpex/client/products.rb
+- lib/tpex/client.rb
+- lib/tpex/configuration.rb
+- lib/tpex/connection.rb
+- lib/tpex/error.rb
+- lib/tpex/request.rb
+- lib/tpex/response.rb
+- lib/tpex/servicescsrf.rb
+- lib/tpex/version.rb
+- lib/tpex.rb
+- spec/spec_helper.rb
+homepage: http://performance.nrel.gov
+licenses:
+- LGPL
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '1.9'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: 1.3.6
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.0.3
+signing_key: 
+specification_version: 4
+summary: Client library for NREL's Technology Performance Exchange
+test_files:
+- spec/spec_helper.rb