magnifier 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 566f64646236871263cabb77135b77131e4214a6
-  data.tar.gz: 7a2359673ee66e9971f51586b65226ce8630fb4d
+  metadata.gz: 0386e1e55cd76eea5ccb2e630d9c74beda25f267
+  data.tar.gz: f08e29e09e25797eba6709d179a9b7659e7dee33
 SHA512:
-  metadata.gz: 6347ffbd8b90e5b1c2d8be48fb79f597c19d64e7f99dbf0042776ef67ae8bcddef95629c005ef67d714cf2edf24706b88a843b7b203d9a582b8cb0552a68e87d
-  data.tar.gz: 5590c57802581ceda6fb78017f69f904488e654bf2330689785ea60cc88245200513e8cbf575a4a36c44407cb3a61dab987f5a9b4a4706ec6bd0a272a1fd4808
+  metadata.gz: c45aad99e85ecb1508026099c13d89be3a81c7727a090314cc1b7663e342546373e23e18b51e6feb8533fa7a7459895ff74921328ea6116358a4da613a3df666
+  data.tar.gz: fef1f8d0c814c2ff3f373302b01c9b64488725a4831aafab4a7b29064c3133545edaeb01d17f457a5bc796a9d517eba76d1c4a228c7a1b0517bbfe7274e346ef

data/README.md

@@ -1,6 +1,6 @@
 # Magnifier
 
-TODO: Write a gem description
+Magnifier makes it possible to communicate with the Eskes Media Magazine Maker engine and perform various tasks (duplicate, make_preview, etc.) to projects, without having to deal with the API directly. To communicate with the API, you need an API-key, provided by the Magazine Maker.
 
 ## Installation
 
@@ -12,13 +12,23 @@ And then execute:
 
     $ bundle
 
+    # after installation, run this command to install the settings file (.yml)
+    $ rails generate magnifier
+
 Or install it yourself as:
 
     $ gem install magnifier
 
 ## Usage
 
-TODO: Write usage instructions here
+### Project
+- To fetch a list of all projects: `Magnifier::Project.all`
+- To fetch a project: `Magnifier::Project.find(123)`
+
+#### Public methods
+	# duplicate
+	# duplicates the current project. Example:
+	new_project = Project.find(123).duplicate
 
 ## Contributing
 

data/config/magnifier_options.yml

@@ -0,0 +1,3 @@
+magnifier_options: 
+  site: "http://www.mijndagjeweg.nl/"
+  api_key: "your-api-key"

data/lib/generators/magnifier_generator.rb

@@ -0,0 +1,30 @@
+class MagnifierGenerator < Rails::Generators::Base
+
+  source_root File.join(File.dirname(__FILE__), "templates")
+
+  # Description:
+  # Copies the migration file into the application.  
+  def install
+    # Example:
+    #     rails generate magnifier
+
+    copy_options_file
+  end
+
+  private
+
+
+  
+  def copy_options_file
+    copy_file File.join(config_path, 'magnifier_options.yml'), config_destination
+  end
+
+  def config_path
+    File.join(%w(.. .. .. config))
+  end
+  
+  def config_destination
+    'config/magnifier_options.yml'
+  end
+
+end

data/lib/magnifier.rb

@@ -1,4 +1,5 @@
 require "magnifier/version"
+
 require 'magnifier/railtie' if defined?(Rails)
 
 module Magnifier
@@ -20,20 +21,10 @@ module Magnifier
 		end
 	end	
 
-	class Project < ActiveResource::Base
-		headers['X-AUTH-TOKEN'] = Settings.api_key
-	  self.site = Settings.site
-	end
-
-	class Page < ActiveResource::Base
-		headers['X-AUTH-TOKEN'] = Settings.api_key
-	  self.site = Settings.site
-	end
+	require "magnifier/project"
+	require "magnifier/page"
+	require "magnifier/page_element"
 
-	class PageElement < ActiveResource::Base
-		headers['X-AUTH-TOKEN'] = Settings.api_key
-	  self.site = Settings.site
-	end
 
 	# private
 

data/lib/magnifier/page.rb

@@ -0,0 +1,11 @@
+include Magnifier
+
+class Page < ActiveResource::Base
+	headers['X-AUTH-TOKEN'] = Settings.api_key
+  self.site = Settings.site
+
+  # forces the magazin make engine to produce a new preview of this page
+  def make_preview
+  	self.get :make_preview
+  end
+end

data/lib/magnifier/page_element.rb

@@ -0,0 +1,20 @@
+include Magnifier
+class PageElement < ActiveResource::Base
+	headers['X-AUTH-TOKEN'] = Settings.api_key
+  self.site = Settings.site
+
+  def replace_content(old_value, new_value)
+  	if content.include? old_value
+	  	c = content.gsub(old_value, new_value)
+	  	self.content = c
+	  	self.save
+	  else
+	  	return false
+	  end
+  end
+
+  # upload or use a photo
+  def use_photo(url)
+    self.post :update_with_photo, url: url
+  end
+end

data/lib/magnifier/project.rb

@@ -0,0 +1,12 @@
+include Magnifier
+class Project < ActiveResource::Base
+	headers['X-AUTH-TOKEN'] = Settings.api_key
+  self.site = Settings.site
+
+  # make a copy of the project
+  def duplicate
+  	new_project = self.get :pick_template
+  	npid = new_project["id"]
+  	return Project.find(npid)
+  end
+end

data/lib/magnifier/railtie.rb

@@ -0,0 +1,7 @@
+require 'rails'
+module Magnifier
+  class Railtie < Rails::Railtie
+		# config.magnify_auth_token = ""  	
+		# config.magnify_site = ""
+  end
+end

data/lib/magnifier/version.rb

@@ -1,3 +1,3 @@
 module Magnifier
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 end

data/magnifier.gemspec

@@ -10,9 +10,11 @@ Gem::Specification.new do |spec|
   spec.email         = ["meijerhenk@gmail.com"]
   spec.description   = %q{Communicate with the Eskes Media Magazine Maker}
   spec.summary       = %q{This gem makes it realy easy to communicate to the Magazine Maker in a ruby-esque way.}
-  spec.homepage      = "http://www.mijndagjeweg.nl/"
+  spec.homepage      = "https://bitbucket.org/eskes_media/magnify"
   spec.license       = "MIT"
 
+  spec.post_install_message = "Thanks for installing! Please run 'rails generate magnifier' to install the options file."
+
   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)/})

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: magnifier
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Henk Meijer
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-06-07 00:00:00.000000000 Z
+date: 2013-06-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -51,14 +51,21 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
+- config/magnifier_options.yml
+- lib/generators/magnifier_generator.rb
 - lib/magnifier.rb
+- lib/magnifier/page.rb
+- lib/magnifier/page_element.rb
+- lib/magnifier/project.rb
+- lib/magnifier/railtie.rb
 - lib/magnifier/version.rb
 - magnifier.gemspec
-homepage: http://www.mijndagjeweg.nl/
+homepage: https://bitbucket.org/eskes_media/magnify
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message: Thanks for installing! Please run 'rails generate magnifier'
+  to install the options file.
 rdoc_options: []
 require_paths:
 - lib