lws 0.1.2.1 → 0.1.3

data/README.rdoc

@@ -0,0 +1,59 @@
+= LeftClick Web Services
+
+LWS is a library for Ruby provides access to the LeftClick web
+services/applications using a model-based structure that abstracts from API
+calls using the available REST interfaces.
+
+== Installation
+
+In your Gemfile, add:
+
+  gem "lws"
+
+or install the +ruby-lws+ package.
+
+
+== Usage
+
+First, you have to initialize the library.  For example, with Rails, you
+would create a new +config/initializers/lws.rb+ file with these lines:
+
+  # config/initializers/lws.rb
+  LWS.setup do |config|
+    config.api_token = "…" # Get it from someplace
+  end
+
+After that, due to the fact that LWS is based on Her, you can access the
+objects in the LeftClick Web Services similary to many ActiveRecord-like
+ORM's:
+
+  map = Maps::Map.all.first
+  markers = map.markers
+
+  company = Company.find(6)
+  account = Auth::Account.create(name: "Foo Bar",
+                                 company: company)
+
+  loc = Presence::Location.where(name: "Test")
+  loc.destroy
+   
+== Configuration
+
+The following example uses a much more elaborate setup:
+
+  LWS.setup do |config|
+    config.api_token = "…"
+    config.caching_object = MyRedisCache.new
+    config.environment = :development
+    config.endponts = { maps: "https://maps.leftclick.eu" }
+    config.http_debug = true
+    config.json_debug = true
+  end
+
+In this setup, a caching object is used that follows the
++FaradayMiddleWare::Caching+ API.  It uses all development API endpoints,
+except for maps, which is overriden to use the production endpoint.  Also
+HTTP request and JSON data debug logging is enabled.
+
+The +LC_LWS_ENV+  is supported to override the LWS environment.
+Allowed values are "production" (default) and "development".

data/Rakefile

@@ -10,7 +10,7 @@ Rake::TestTask.new do |t|
 end
 
 YARD::Rake::YardocTask.new do |t|
-  t.files = ["lib"]
+  t.files = ["README.rdoc", "lib"]
   t.options = ["--no-private",
                "--title", "LeftClick Web Services Documentation"]
 end

data/lib/lws/auth.rb

@@ -2,11 +2,15 @@
 module LWS::Auth
 
   # The API endpoint for the auth app
-  ENDPOINT = "https://auth.leftclick.eu/" unless defined? ENDPOINT
+  unless defined? ENDPOINT
+    ENDPOINT = { production: "https://auth.leftclick.eu/" ,
+                 development: "https://auth-dev.leftclick.eu/" }
+  end
 
   # @!visibility private
   def self.api
-    LWS.setup_api(LWS.config.endpoints[:auth] || ENDPOINT)
+    LWS.setup_api(LWS.config.endpoints[:auth] ||
+                  ENDPOINT[LWS.config.environment])
   end
 
   ### Generic classes

data/lib/lws/maps.rb

@@ -2,11 +2,15 @@
 module LWS::Maps
 
   # The API endpoint for the map app
-  ENDPOINT = "https://maps.leftclick.eu/" unless defined? ENDPOINT
+  unless defined? ENDPOINT
+    ENDPOINT = { production: "https://maps.leftclick.eu/",
+                 development: "https://maps-dev.leftclick.eu/" }
+  end
 
   #@!visibility private
   def self.api
-    LWS.setup_api(LWS.config.endpoints[:maps] || ENDPOINT)
+    LWS.setup_api(LWS.config.endpoints[:maps] ||
+                  ENDPOINT[LWS.config.environment])
   end
 
   ### Generic classes

data/lib/lws/presence.rb

@@ -2,11 +2,15 @@
 module LWS::Presence
 
   # The API endpoint for the presence app
-  ENDPOINT = "https://presence.leftclick.eu/" unless defined? ENDPOINT
+  unless defined? ENDPOINT
+    ENDPOINT = { production: "https://presence.leftclick.eu/",
+                 development: "https://presence-dev.leftclick.eu/" }
+  end
 
   #@!visibility private
   def self.api
-    LWS.setup_api(LWS.config.endpoints[:presence] || ENDPOINT)
+    LWS.setup_api(LWS.config.endpoints[:presence] ||
+                  ENDPOINT[LWS.config.environment])
   end
 
   ### Generic classes

data/lib/lws/version.rb

@@ -2,6 +2,6 @@ module LWS
 
   # The LWS library version.
   # @note This is not the API version!
-  VERSION = '0.1.2.1'
+  VERSION = '0.1.3'
 
 end

data/lib/lws.rb

@@ -84,6 +84,10 @@ module LWS
     #    overrides
     property :endpoints, default: {}
 
+    #@!attribte environment
+    #  @return [Symbol] the (default) API environment
+    property :environment, default: :production
+
     #@!attribute http_debug
     #  @return [Boolean] whether to show HTTP debug messages
     property :http_debug, default: false
@@ -113,6 +117,11 @@ module LWS
 
     raise "API token is required" if config.api_token.blank?
 
+    # Override the environment if needed
+    if ENV["LC_LWS_ENV"].present?
+      @@config.environment = ENV["LC_LWS_ENV"].to_sym
+    end
+
     load_app_modules
 
     return self

data/test/test_generic.rb

@@ -9,11 +9,12 @@ class TestGenericConfiguration < MiniTest::Unit::TestCase
     @configuration = Configuration.all.first
   end
 
-  def test_valid_configuration
-    refute_nil(@configuration)
-    assert_instance_of(Configuration, @configuration)
-    refute_nil(@configuration.id)
-  end
+  # FIXME: renable this test once some configurations are available again
+  #def test_valid_configuration
+  #  refute_nil(@configuration)
+  #  assert_instance_of(Configuration, @configuration)
+  #  refute_nil(@configuration.id)
+  #end
 
 end
 

data/test/test_helper.rb

@@ -9,7 +9,5 @@ LWS.setup do |config|
     config.http_debug = true
     config.json_debug = true
   end
-  config.endpoints = { auth: "https://auth-dev.leftclick.eu",
-                       maps: "https://maps-dev.leftclick.eu",
-                       presence: "https://presence-dev.leftclick.eu" }
+  config.environment = :development
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: lws
 version: !ruby/object:Gem::Version
-  version: 0.1.2.1
+  version: 0.1.3
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-02-26 00:00:00.000000000 Z
+date: 2016-03-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday_middleware
-  requirement: &16029460 !ruby/object:Gem::Requirement
+  requirement: &10903360 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -24,10 +24,10 @@ dependencies:
         version: '1.0'
   type: :runtime
   prerelease: false
-  version_requirements: *16029460
+  version_requirements: *10903360
 - !ruby/object:Gem::Dependency
   name: hashie
-  requirement: &16028600 !ruby/object:Gem::Requirement
+  requirement: &10902460 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -35,10 +35,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *16028600
+  version_requirements: *10902460
 - !ruby/object:Gem::Dependency
   name: her
-  requirement: &16027860 !ruby/object:Gem::Requirement
+  requirement: &10901740 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -46,10 +46,10 @@ dependencies:
         version: 0.8.1
   type: :runtime
   prerelease: false
-  version_requirements: *16027860
+  version_requirements: *10901740
 - !ruby/object:Gem::Dependency
   name: hashie
-  requirement: &16027280 !ruby/object:Gem::Requirement
+  requirement: &10901140 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -57,10 +57,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *16027280
+  version_requirements: *10901140
 - !ruby/object:Gem::Dependency
   name: her
-  requirement: &16026560 !ruby/object:Gem::Requirement
+  requirement: &10900440 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -68,10 +68,10 @@ dependencies:
         version: 0.8.1
   type: :development
   prerelease: false
-  version_requirements: *16026560
+  version_requirements: *10900440
 - !ruby/object:Gem::Dependency
   name: minitest
-  requirement: &16025980 !ruby/object:Gem::Requirement
+  requirement: &10899860 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -79,10 +79,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *16025980
+  version_requirements: *10899860
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &16041720 !ruby/object:Gem::Requirement
+  requirement: &10915620 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -90,7 +90,7 @@ dependencies:
         version: 0.9.2
   type: :development
   prerelease: false
-  version_requirements: *16041720
+  version_requirements: *10915620
 description: ! "This library for Ruby provides access to the LeftClick\n web services/applications
   using a model-based structure that abstracts from API calls\n using the available
   REST interfaces."
@@ -103,6 +103,7 @@ extra_rdoc_files: []
 files:
 - .gitignore
 - Gemfile
+- README.rdoc
 - Rakefile
 - bin/lwsconsole
 - lib/lws.rb