finerworks 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: c3c4c9dc051625f149a4d8ee5ca48de3f13c92b7
+  data.tar.gz: d29862702db6a733cf04ec084949d98dde9b7519
+SHA512:
+  metadata.gz: d25b11d9c70ccb35e4abbbd29fe078c97707a598e91e55bea23a6669f0bfe9d88baa7efbe9f95c044d3c28e0662d88bc40580bdd7aa1b05766a028f2fa383cfd
+  data.tar.gz: db84180174265d98f3a6f54baf09efe344ce4250c5746dc4657ac4ba5fb5c174164c8a33864c8e7002cad2654e1f1e24caf4915268969f421a067148bf1cd309

data/lib/finerworks.rb

@@ -0,0 +1,3 @@
+require 'hashie'
+require 'finerworks/utilities'
+require 'finerworks/client'

data/lib/finerworks/account.rb

@@ -0,0 +1,29 @@
+module FinerWorks
+  class Account < Hashie::Trash
+    property :business_company_name, from: "AccountBusinessCompanyName"
+    property :business_department, from: "AccountBusinessDepartment"
+    property :company_description, from: "AccountCompanyDescription"
+    property :business_website_url, from: "AccountBusinessWebsiteURL"
+    property :business_address1, from: "AccountBusinessAddress1"
+    property :business_address2, from: "AccountBusinessAddress2"
+    property :business_city, from: "AccountBusinessCity"
+    property :business_state, from: "AccountBusinessState"
+    property :business_country, from: "AccountBusinessCountry"
+    property :business_zip, from: "AccountBusinessZip"
+    property :business_phone, from: "AccountBusinessPhone"
+    property :business_fax, from: "AccountBusinessFax"
+    property :username, from: "AccountUsername"
+    property :registration_date, from: "AccountRegistrationDate", transform_with: lambda { |d| FinerWorks::Utilities.parse_api_time(d) }
+    property :email, from: "AccountEmail"
+    property :type, from: "AccountType"
+    property :first_name, from: "AccountFirstName"
+    property :middle_name, from: "AccountMiddleName"
+    property :last_name, from: "AccountLastName"
+    property :phone, from: "AccountPhone"
+    property :logo_file, from: "AccountLogoFile"
+    property :portrait_file, from: "AccountPortraitFile"
+    property :bio, from: "AccountBio"
+    property :title, from: "AccountTitle"
+    property :seller_paypal_email, from: "AccountSellerPayPalEmail"
+  end
+end

data/lib/finerworks/client.rb

@@ -0,0 +1,95 @@
+require 'finerworks/request'
+require 'finerworks/response'
+require 'finerworks/account'
+require 'finerworks/print'
+require 'finerworks/gallery'
+require 'finerworks/image'
+require 'finerworks/order'
+
+module FinerWorks
+  class Client
+    attr_accessor :account_api_key
+
+    def initialize(options = {})
+      options.each do |key, value|
+        instance_variable_set("@#{key}", value)
+      end
+      yield(self) if block_given?
+    end
+
+    # Provides account profile information.
+    def account
+      result = FinerWorks::Request.get(self, "/Account")
+      FinerWorks::Account.new(result.json)
+    end
+
+    # Updates account profile information.
+    def update_account(account)
+      result = FinerWorks::Request.post(self, "/Account", build_post_account_json(account))
+    end
+
+    # Lists prints stored in My Prints Inventory.
+    #
+    # ==== Options hash:
+    # ["ImageGUID"] Filter by image.
+    # ["GalleryGUID"] Filter by gallery.
+    def prints(options = {})
+      get(FinerWorks::Print, "/Prints", options)
+    end
+
+    # Lists galleries (aka portfolios) under the current account.
+    def galleries
+      get(FinerWorks::Gallery, "/Galleries")
+    end
+
+    # Lists images stored in My Images.
+    #
+    # ==== Options hash:
+    # ["GalleryGUID"] Filter by gallery.
+    # ["Sort"] Sort images by upload date in ascending or descending order. Possible values are "ASC" and "DESC".
+    #          Default is descending.
+    def images(options = {})
+      get(FinerWorks::Image, "/Images", options)
+    end
+
+    # Lists orders
+    #
+    # ==== Options hash:
+    # ["OrderDateTime_Start"] Search for orders in the range starting at the specified date/time.
+    # ["OrderDateTime_End"] Search for orders in the range ending at the specified date/time.
+    # ["OrderStatusID"] Search for orders with a specific status.
+    # ["OrderID"] Find a specific order by ID.
+    # ["Sort"] Sort orders by ID in ascending or descending order. Possible values are "ASC" and "DESC". Default is
+    #          descending.
+    def orders(options = {})
+      get(FinerWorks::Order, "/Orders", options)
+    end
+
+    # Generic GET method to request items of the specified +type+. This always returns an +Array+.
+    def get(type, path, options = {})
+      response = FinerWorks::Request.get(self, path, options)
+      items = response.json.kind_of?(Array) ? response.json : [response.json]
+      results = []
+      items.each do |item|
+        results << type.new(item)
+      end
+      results
+    end
+
+    def build_post_account_json(account)
+      {
+        "AccountApiKey" => account_api_key,
+        "AccountUsername" => account.username,
+        "AccountUpdate_Info" => {
+          "AccountEmail" => account.email,
+          "AccountFirstName" => account.first_name,
+          "AccountMiddleName" => account.middle_name,
+          "AccountLastName" => account.last_name,
+          "AccountPhone" => account.phone,
+          "AccountBio" => account.bio,
+          "AccountTitle" => account.title
+        }
+      }
+    end
+  end
+end

data/lib/finerworks/gallery.rb

@@ -0,0 +1,9 @@
+module FinerWorks
+  class Gallery < Hashie::Trash
+    property :title, from: "GalleryTitle"
+    property :active, from: "GalleryActive", transform_with: lambda { |value| value == "True" }
+    property :guid, from: "GalleryGUID"
+
+    alias_method :active?, :active
+  end
+end

data/lib/finerworks/image.rb

@@ -0,0 +1,26 @@
+module FinerWorks
+  class Image < Hashie::Trash
+    property :guid, from: "ImageGUID"
+    property :url, from: "ImageUrl"
+    property :url_thumbnail, from: "ImageUrl_Thumbnail"
+    property :original_file_name, from: "ImageOriginalFileName"
+    property :file_name, from: "ImageFileName"
+    property :date_added, from: "ImageDateAdded", transform_with: lambda { |d| FinerWorks::Utilities.parse_api_time(d) }
+    property :active, from: "ImageActive", transform_with: lambda { |value| value == "True" }
+    property :file_size, from: "ImageFileSize"
+    property :w, from: "ImageW"
+    property :h, from: "ImageH"
+    property :title, from: "ImageTitle"
+    property :date_updated, from: "ImageDateUpdated", transform_with: lambda { |d| FinerWorks::Utilities.parse_api_time(d) }
+    property :rank, from: "ImageRank"
+    property :order, from: "ImageOrder"
+    property :rating, from: "ImageRating"
+    property :description, from: "ImageDescription"
+    property :gallery_guid, from: "GalleryGUID"
+    property :gallery_title, from: "GalleryTitle"
+    property :gallery_active, from: "GalleryActive"
+
+    alias_method :active?, :active
+    alias_method :gallery_active?, :active
+  end
+end

data/lib/finerworks/order.rb

@@ -0,0 +1,10 @@
+module FinerWorks
+  class Order < Hashie::Trash
+    property :id, from: "OrderID"
+    property :grand_total, from: "OrderGrandTotal"
+    property :date_time, from: "OrderDateTime", transform_with: lambda { |d| FinerWorks::Utilities.parse_api_time(d) }
+    property :drop_ship, from: "OrderDropShip"
+    property :status_id, from: "OrderStatusID"
+    property :status_label, from: "OrderStatusLabel"
+  end
+end

data/lib/finerworks/print.rb

@@ -0,0 +1,26 @@
+module FinerWorks
+  class Print < Hashie::Trash
+    property :add_on_title, from: "AddOnTitle"
+    property :canvas_add_on_name, from: "CanvasAddOnName"
+    property :card_stock_name, from: "CardStockName"
+    property :card_style_name, from: "CardStyleName"
+    property :image_guid, from: "ImageGUID"
+    property :image_title, from: "ImageTitle"
+    property :media_name, from: "MediaName"
+    property :mounting_name, from: "MountingName"
+    property :date_added, from: "PrintDateAdded", transform_with: lambda { |d| FinerWorks::Utilities.parse_api_time(d) }
+    property :description, from: "PrintDescription"
+    property :guid, from: "PrintGUID"
+    property :media_id, from: "PrintMediaID"
+    property :minor_retouch, from: "PrintMinorRetouch"
+    property :mounting_id, from: "PrintMountingID"
+    property :preview_file, from: "PrintPreviewFile"
+    property :product_preview_file, from: "PrintProductPreviewFile"
+    property :sale_price, from: "PrintSalePrice"
+    property :shipping_additional_price, from: "PrintShippingAdditionalPrice"
+    property :shipping_base_price, from: "PrintShippingBasePrice"
+    property :title, from: "PrintTitle"
+    property :gallery_guid, from: "GalleryGUID"
+    property :thumbnail_url, from: "PrintThumbnailUrl"
+  end
+end

data/lib/finerworks/request.rb

@@ -0,0 +1,32 @@
+require 'uri'
+require 'net/http'
+
+module FinerWorks
+  class Request
+    BASE_URL = "http://api.finerworks.com/api"
+
+    def self.get(client, path, options = {})
+      path.prepend("/") if !path.start_with?("/")
+      params = ""
+      options.each do |option|
+        params = params + "&#{option[0].to_s}=#{option[1]}"
+      end
+      uri = URI.parse("#{BASE_URL}#{path}?AccountApiKey=#{client.account_api_key}#{params}")
+      http = Net::HTTP.new(uri.host, uri.port)
+      request = Net::HTTP::Get.new(uri.request_uri)
+      response = http.request(request)
+      FinerWorks::Response.new(response)
+    end
+
+    def self.post(client, path, options = {})
+      path.prepend("/") if !path.start_with?("/")
+      uri = URI.parse("#{BASE_URL}#{path}?AccountApiKey=#{client.account_api_key}")
+      http = Net::HTTP.new(uri.host, uri.port)
+      request = Net::HTTP::Post.new(uri.request_uri)
+      request.body = options.to_json
+      request.content_type = "application/json"
+      response = http.request(request)
+      FinerWorks::Response.new(response)
+    end
+  end
+end

data/lib/finerworks/response.rb

@@ -0,0 +1,14 @@
+require 'json'
+
+module FinerWorks
+  class Response
+    attr_accessor :body, :json, :code, :message
+
+    def initialize(http_response)
+      @code = http_response.code
+      @message = http_response.message
+      @body = http_response.body
+      @json = JSON.parse(@body)
+    end
+  end
+end

data/lib/finerworks/utilities.rb

@@ -0,0 +1,13 @@
+require 'time'
+
+module FinerWorks
+  module Utilities
+    module_function
+
+    # Parse ISO 8601 time strings from the FinerWorks Web API. This function takes into consideration the fact that
+    # the FinerWorks API does not specify a time zone in its responses, yet it appears to use US Central Time.
+    def parse_api_time(time_string)
+      Time.parse(time_string.split("T").first + "T00:00:00-0600")
+    end
+  end
+end

metadata

@@ -0,0 +1,125 @@
+--- !ruby/object:Gem::Specification
+name: finerworks
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Jeff Fredrickson
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-09-18 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.4'
+- !ruby/object:Gem::Dependency
+  name: hashie
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.8'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.21'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.21'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+description: This gem wraps the FinerWorks Web API in order to provide an easy way
+  to utilize the API in Ruby apps.
+email:
+- jeff.fredrickson@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/finerworks.rb
+- lib/finerworks/account.rb
+- lib/finerworks/client.rb
+- lib/finerworks/gallery.rb
+- lib/finerworks/image.rb
+- lib/finerworks/order.rb
+- lib/finerworks/print.rb
+- lib/finerworks/request.rb
+- lib/finerworks/response.rb
+- lib/finerworks/utilities.rb
+homepage: https://github.com/jfredrickson/finerworks
+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.4.5.1
+signing_key: 
+specification_version: 4
+summary: Ruby interface for the FinerWorks Web API
+test_files: []