fcfinder 0.1.1 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 71430280fb0cb028149a2deddcad49155cad48db
-  data.tar.gz: 0d46014e94abc9aa523a79373e16f4cd615a9d46
+  metadata.gz: 1b57ca6fca80da6af0950e0cd90cdf19c96a6f0c
+  data.tar.gz: 2bbcfc37cb28fbf1c8084fbacf8088b59acb6de2
 SHA512:
-  metadata.gz: 83890395444510d0704889b83d543342cbcb954950a9d1b15a5e3ad7b1749578350b707dfa186661fc00ebfd0730545f9b13fd8f42e9dcdb5aec44705939cc3b
-  data.tar.gz: 01e84d9e4297d386816c05dde13f8da17336b94ad2ed2c14fa36182ed670cb0060aa83b6dec1c0a65b44ba139effc1c43f1859125cf86eaedfa8f3c201f5a14a
+  metadata.gz: fed2e28ae80fc4ac6592c3e1ed1ca2cd0b494b827d280fb9b349905e6ae56e3b4eefa8ecd437fb4f7a54e40577a67900d40a99e59e4760e7a9ea0de142f5b7ba
+  data.tar.gz: ae7557bc06ff942f9d2471a20b5e25d0f86b97f48d3becefae8d382c4a963901dc796e5f752fe72f6c95deafd459aedd80f2aa353c0c3b43f5c2363ee412a4f5

data/.gitignore

@@ -1,10 +1,9 @@
-/.bundle/
-/.yardoc
-/Gemfile.lock
-/_yardoc/
-/coverage/
-/doc/
-/pkg/
-/spec/reports/
-/tmp/
-/Readme.md
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.travis.yml

@@ -1,3 +1,3 @@
-language: ruby
-rvm:
-  - 2.1.5
+language: ruby
+rvm:
+  - 2.1.5

data/CODE_OF_CONDUCT.md

@@ -1,13 +1,13 @@
-# Contributor Code of Conduct
-
-As contributors and maintainers of this project, we pledge to respect all people who contribute through reporting issues, posting feature requests, updating documentation, submitting pull requests or patches, and other activities.
-
-We are committed to making participation in this project a harassment-free experience for everyone, regardless of level of experience, gender, gender identity and expression, sexual orientation, disability, personal appearance, body size, race, age, or religion.
-
-Examples of unacceptable behavior by participants include the use of sexual language or imagery, derogatory comments or personal attacks, trolling, public or private harassment, insults, or other unprofessional conduct.
-
-Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct. Project maintainers who do not follow the Code of Conduct may be removed from the project team.
-
-Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by opening an issue or contacting one or more of the project maintainers.
-
-This Code of Conduct is adapted from the [Contributor Covenant](http:contributor-covenant.org), version 1.0.0, available at [http://contributor-covenant.org/version/1/0/0/](http://contributor-covenant.org/version/1/0/0/)
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, we pledge to respect all people who contribute through reporting issues, posting feature requests, updating documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free experience for everyone, regardless of level of experience, gender, gender identity and expression, sexual orientation, disability, personal appearance, body size, race, age, or religion.
+
+Examples of unacceptable behavior by participants include the use of sexual language or imagery, derogatory comments or personal attacks, trolling, public or private harassment, insults, or other unprofessional conduct.
+
+Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct. Project maintainers who do not follow the Code of Conduct may be removed from the project team.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by opening an issue or contacting one or more of the project maintainers.
+
+This Code of Conduct is adapted from the [Contributor Covenant](http:contributor-covenant.org), version 1.0.0, available at [http://contributor-covenant.org/version/1/0/0/](http://contributor-covenant.org/version/1/0/0/)

data/Gemfile

@@ -1,4 +1,4 @@
-source 'https://rubygems.org'
-
-# Specify your gem's dependencies in fcfinder.gemspec
-gemspec
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in fcfinder.gemspec
+gemspec

data/LICENSE.txt

@@ -1,21 +1,21 @@
-The MIT License (MIT)
-
-Copyright (c) 2015 Furkan Çelik
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in
-all copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
-THE SOFTWARE.
+The MIT License (MIT)
+
+Copyright (c) 2015 Furkan Çelik
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,356 @@
+# Fcfinder
+
+[![Gem Version](https://badge.fury.io/rb/fcfinder.svg)](http://badge.fury.io/rb/fcfinder)
+
+Rails İçin Web Dosya Gezgini 
+CKEditor ve Tinymce ile Hızlı ve Basit bir şekilde Entegreli olarak kullanabileceğiniz dosya gezgini.
+
+![Arayuzu](https://raw.githubusercontent.com/furkancelik/fcfinder/master/screenshots/fcfinder_interface.png)
+
+## Gereklilikler
+
+###ImageMagick
+
+[imagemagick](http://github.com)'in kurulu olması gerekmektedir.
+
+Windows Kurulumu İçin;
+[imagemagick](http://github.com) adresinden download butonundan 
+Windows Binary Release alanından **ruby ile uyumlu** (kurulu olan x64 x86 ile aynı)
+ImageMagick-******-dll.exe Dosyasını İndirip Kurabilirsiniz kurulum işleminde path ortam değişkenine eklendiğine emin olun.
+
+Komut Satırına
+
+`convert -version`
+
+yazdığınızda bu şekilde başarıyla yüklediğinizi görebilirsiniz.
+
+```
+Version: ImageMagick 6.9.1-4 Q16 x86 2015-05-31 http://www.imagemagick.org
+Copyright: Copyright (C) 1999-2015 ImageMagick Studio LLC
+License: http://www.imagemagick.org/script/license.php
+Features:  Cipher DPC Modules OpenMP
+...
+```
+
+### Puma Server (İsteğe Bağlı)
+Gereklilik şartı yok ama büyük dosyaları yükleme işleminde webrick sorun çıkartabiliyor
+pumanın windows için kurulumuna [buradan](https://github.com/hicknhack-software/rails-disco/wiki/Installing-puma-on-windows) bakabilirsiniz.
+
+
+
+## Kurulum
+
+Rails uygulamaları için Gemfile dosyanıza alttaki satırı eklemelisiniz
+
+```ruby
+gem 'fcfinder'
+```
+
+```
+$ bundle install
+```
+
+ile rails için yükleme işlemini gerçekleştirebilirsiniz.
+
+
+## Kullanım
+
+###Controller Ayarı
+
+```ruby
+class SizinControlleriniz < ApplicationController
+
+  def index
+	if request.post?
+	  # Alttaki Satırla Sadece Giriş Yapan Kullanıcıların (Admin'in) Finder'e erişimini Sağlayabilirsiniz
+	  # Session Adını Sisteminizde Kullandığınız Adla Aynı Olmalı
+	  # Oturu Açma İşlemi Olmayacaksa Bu Satırı Kaldırabilirsiniz
+	  if session[:user_id]
+		# public klasörü altında istediğiniz isimde dosya oluşturabilirsiniz örnek açısından 'uploads' şeklinde oluşturuldu
+		# File.join(Rails.public_path, 'uploads', "/*")
+		# Paremetre olarak listelenmesini istediğiniz dosyalar,
+		# sunucu adresi,
+		# post paremetrleri,
+		# Hash paremetresi bu hash içerisinde
+		# :max_file_size = yüklenecek dosyanın boyutunu belirtiyor (byte)
+		# :allowed_mime = ekstra olarak izin vermek istediğiniz dosya tipleri
+		# :disallowed_mime = izin verilmeyen dosya tipleri
+        render text: Fcfinder::Connector.new(File.join(Rails.public_path, 'uploads', "/*"), request.env["HTTP_HOST"], params[:fcfinder],
+                                             {
+                                                 :max_file_size => 1_000_000,
+                                                 :allowed_mime => {'pdf' => 'application/pdf'},
+                                                 :disallowed_mime => {}
+                                             }).run, :layout => false
+      # Eğer Oturum Açılmamışsa 
+	  #(session[:user_id] if bloğunu kaldırdıysanız bu else kısmınıda kaldırmalısınız)
+	  else
+	  # session_id değeri boş ise erişimi kapatıyor dosyalarınız güvende oluyor.
+        render :text => "Access not allowed!".to_json, :layout => false
+      end
+    else
+	#
+      render :layout => false
+    end
+  end
+
+
+  #dosya indirme işlemi için 
+  def download
+	# 'uploads' kısmı yine public klasörü altında olan klasörünüz.
+    send_file File.join(Rails.public_path,'uploads',params[:path].split(":").join("/")+"."+params[:format])
+  end
+end
+```
+###Rota Ayarı
+
+```ruby
+scope '/fcfinder' do
+  match '/', to: 'sizin_controlleriniz#index', via: [:get, :post]
+  get '/download/:path', to: 'sizin_controlleriniz#download'
+end
+```
+**Eğer bir namespace altında kullanmak isterseniz bu şekilde kullanabilirsiniz**
+
+```ruby
+namespace :admin do
+  scope '/fcfinder' do
+    match '/', to: 'sizin_controlleriniz#index', via: [:get, :post]
+	get '/download/:path', to: 'sizin_controlleriniz#download'
+  end
+end 
+```
+
+###View Ayarı
+
+####1.Yöntem
+**app/assets/javascripts/application.js dosyanızda**
+
+```js
+//= require jquery
+//= require jquery_ujs
+```
+
+bu satırlar ekli olmalıdır ***(jQuery'nin yüklü olduğuna emin olun!!)***
+
+
+**config/initializers/assets.rb** dosyasında en alta 
+
+```ruby
+Rails.application.config.assets.precompile += %w( fcfinder.js )
+Rails.application.config.assets.precompile += %w( fcfinder.css )
+```
+satırlarını eklemelisiniz
+
+**Viewdeki dosyanızın içeriği bu şekilde olmalıdır**
+
+```html
+<!DOCTYPE html>
+<html>
+  <head>
+    <title>FcFinder</title>
+    
+   <%= stylesheet_link_tag    'application', media: 'all', 'data-turbolinks-track' => true %>
+   <%= javascript_include_tag 'application', 'data-turbolinks-track' => true %>
+   
+   <%= javascript_include_tag 'fcfinder', 'data-turbolinks-track' => true %>
+   <%= stylesheet_link_tag    'fcfinder', media: 'all', 'data-turbolinks-track' => true %>
+   <%= csrf_meta_tags %>
+  </head>
+  <body>
+    <div id="fcfinder"></div>
+    
+	<script type="text/javascript">
+      $(function(){
+        $("#fcfinder").fcFinder({
+			// bu değer rotada ayarladığınız adres olmalı
+			url:"/fcfinder",
+        getFileCallback: function(url) {
+          /**
+			Editör Entegre İşlemleri İlk Etap İçin Bu Değeri Boş Bırakabilirsiniz
+			Varsayılan Olarak CKEditor ile Entegrebir şekilde çalışıyor
+		  */   
+			}
+        });
+      });
+    </script>
+  </body>
+</html>
+```
+
+####2.Yöntem
+
+**app/assets/javascripts/application.js dosyanızda**
+jquery Dosyalarını Yüklü Olduğuna emin olun ve 
+
+```js
+//= require jquery
+//= require jquery_ujs
+```
+altına 
+
+```js
+//= require fcfinder
+```
+satırını ekleyin
+
+
+**app/assets/stylesheets/application.css dosyasına**
+
+```css
+ *= require fcfinder
+```
+
+satırını ekleyin
+
+
+
+**Viewdeki dosyanızın içeriği bu şekilde olmalıdır**
+
+```html
+<!DOCTYPE html>
+<html>
+  <head>
+    <title>FcFinder</title>
+    
+   <%= stylesheet_link_tag    'application', media: 'all', 'data-turbolinks-track' => true %>
+   <%= javascript_include_tag 'application', 'data-turbolinks-track' => true %>
+   <%= csrf_meta_tags %>
+   
+  </head>
+  <body>
+    <div id="fcfinder"></div>
+    
+	<script type="text/javascript">
+      $(function(){
+        $("#fcfinder").fcFinder({
+			// bu değer rotada ayarladığınız adres olmalı
+			url:"/fcfinder",
+        getFileCallback: function(url) {
+          /**
+			Editör Entegre İşlemleri İlk Etap İçin Bu Değeri Boş Bırakabilirsiniz
+			Varsayılan Olarak CKEditor ile Entegrebir şekilde çalışıyor
+		  */   
+			}
+        });
+      });
+    </script>
+  </body>
+</html>
+```
+
+
+**Şimdi Sunucunuzu Başlatıp Test Edebilirsiniz :)**
+
+## Entegre İşlemleri
+### CKEditor
+
+Varsayılan olarak ckeditor ile entegreli olarak geliyor. 
+CKEditorün Bulunduğu Sayfada 
+```js
+CKEDITOR.replace( 'editor1',{
+	/* Bu Şekilde CKEditorde finder yolunu belirteceksiniz. */
+	filebrowserBrowseUrl : 'http://localhost:3000/fcfinder'
+});
+```
+
+### Tinymce
+
+Tinymce Editorun bulunduğu sayfada
+```js
+function fcFinderBrowser (field_name, url, type, win) {
+        tinymce.activeEditor.windowManager.open({
+		/* Finder urlsi */
+        file: "http://localhost:3000/admin/fcfinder",
+		title: 'FCFinder Dosya Yöneticisi',
+        width: 900,
+        height: 450,
+        resizable: 'yes'
+        }, {
+            setUrl: function (url) {
+				win.document.getElementById(field_name).value = url;
+            }
+        });
+	return false;
+}
+
+tinymce.init({
+		selector: "textarea#elm1",
+		theme: "modern",
+		file_browser_callback : fcFinderBrowser,
+		....
+		...
+		..
+		.
+	});
+```
+
+**FcFinder'in bulunduğu sayfada**
+
+```js
+$("#fcfinder").fcFinder({
+        url:"/admin/fcfinder",
+        getFileCallback: function(url) {
+		
+          if (typeof(window.opener) !== 'undefined' && window.opener !== null) {
+            window.opener.FCFinder.callBack(url);
+            window.close();
+          }
+
+          if (typeof(top.tinymce) !== 'undefined' && typeof(top.tinymce) !== null) {
+            top.tinymce.activeEditor.windowManager.getParams().setUrl(url);
+            top.tinymce.activeEditor.windowManager.close();
+          }
+
+      }
+});
+```
+
+### Input için Entegre İşlemi
+
+**inputun bulunduğu sayfa**
+```html
+<html>
+<head>
+	<script type="text/javascript">
+	function openFCFinder(field) {
+	window.FCFinder = {
+        callBack: function(url) {
+            field.value = url;
+        }
+    };
+	
+	window.open('http://localhost:3000/admin/fcfinder', 'kcfinder_textbox',
+        'status=0, toolbar=0, location=0, menubar=0, directories=0, ' +
+        'resizable=1, scrollbars=0, width=950, height=400'
+    );
+}
+</script>
+</head>
+<body>
+<input type="text" readonly="readonly" onclick="openFCFinder(this)"
+    value="Click here and select a file double clicking on it" style="width:600px;cursor:pointer" />
+</body>
+</html>
+```
+
+**Finder bulunduğu sayfa (finder paremetre ayarı)**
+
+
+```js
+$("#fcfinders").fcFinder({
+        url:"/admin/fcfinder",
+        getFileCallback: function(url) {
+
+          if (typeof(window.opener) !== 'undefined' && window.opener !== null) {
+            window.opener.FCFinder.callBack(url);
+            window.close();
+          }
+
+          if (typeof(top.tinymce) !== 'undefined' && typeof(top.tinymce) !== null) {
+            top.tinymce.activeEditor.windowManager.getParams().setUrl(url);
+            top.tinymce.activeEditor.windowManager.close();
+          }
+	}
+});
+```
+